mirror of
https://github.com/Shubhamsaboo/awesome-llm-apps.git
synced 2026-03-11 17:48:31 -05:00
chore: files and folder restructuring
This commit is contained in:
ShubhamSaboo
@@ -1,6 +1,6 @@
|
||||
# AI Speech Trainer: Your Multimodal Public Speaking Coach
|
||||
# AI Speech Trainer Agent
|
||||
|
||||
## Overview of the Idea
|
||||
## Overview
|
||||
AI Speech Trainer is an AI-powered multi-agent, multimodal public speaking coach that listens to how you speak, watches how you express, and evaluates what you say - helping you become a confident public speaker.
|
||||
|
||||
Whether you're preparing for a TED talk, interview, or school presentation, AI Speech Trainer provides you with personalized feedback, helping you improve your public speaking skills - highlighting your strengths and weaknesses and giving you valuable suggestions to speak better, clearer, and more confidently.
|
||||
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 129 KiB |
@@ -1,152 +0,0 @@
|
||||
# Contributing to Windows-MCP
|
||||
|
||||
Thank you for your interest in contributing to MCP-Use! This document provides guidelines and instructions for contributing to this project.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Development Environment](#development-environment)
|
||||
- [Installation from Source](#installation-from-source)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Branching Strategy](#branching-strategy)
|
||||
- [Commit Messages](#commit-messages)
|
||||
- [Code Style](#code-style)
|
||||
- [Pre-commit Hooks](#pre-commit-hooks)
|
||||
- [Testing](#testing)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Adding Tests](#adding-tests)
|
||||
- [Pull Requests](#pull-requests)
|
||||
- [Creating a Pull Request](#creating-a-pull-request)
|
||||
- [Pull Request Template](#pull-request-template)
|
||||
- [Documentation](#documentation)
|
||||
- [Release Process](#release-process)
|
||||
- [Getting Help](#getting-help)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Development Environment
|
||||
|
||||
Windows MCP requires:
|
||||
- Python 3.11 or later
|
||||
|
||||
### Installation from Source
|
||||
|
||||
1. Fork the repository on GitHub.
|
||||
2. Clone your fork locally:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Jeomon/Windows-MCP.git
|
||||
cd Windows-MCP
|
||||
```
|
||||
|
||||
3. Install the package in development mode:
|
||||
|
||||
```bash
|
||||
pip install -e ".[dev,search]"
|
||||
```
|
||||
|
||||
4. Set up pre-commit hooks:
|
||||
|
||||
```bash
|
||||
pip install pre-commit
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Branching Strategy
|
||||
|
||||
- `main` branch contains the latest stable code
|
||||
- Create feature branches from `main` named according to the feature you're implementing: `feature/your-feature-name`
|
||||
- For bug fixes, use: `fix/bug-description`
|
||||
|
||||
### Commit Messages
|
||||
|
||||
For now no commit style is enforced, try to keep your commit messages informational.
|
||||
|
||||
### Code Style
|
||||
|
||||
Key style guidelines:
|
||||
|
||||
- Line length: 100 characters
|
||||
- Use double quotes for strings
|
||||
- Follow PEP 8 naming conventions
|
||||
- Add type hints to function signatures
|
||||
|
||||
### Pre-commit Hooks
|
||||
|
||||
We use pre-commit hooks to ensure code quality before committing. The configuration is in `.pre-commit-config.yaml`.
|
||||
|
||||
The hooks will:
|
||||
|
||||
- Run linting checks
|
||||
- Check for trailing whitespace and fix it
|
||||
- Ensure files end with a newline
|
||||
- Validate YAML files
|
||||
- Check for large files
|
||||
- Remove debug statements
|
||||
|
||||
## Testing
|
||||
|
||||
### Running Tests
|
||||
|
||||
Run the test suite with pytest:
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
To run specific test categories:
|
||||
|
||||
```bash
|
||||
pytest tests/
|
||||
```
|
||||
|
||||
### Adding Tests
|
||||
|
||||
- Add unit tests for new functionality in `tests/unit/`
|
||||
- For slow or network-dependent tests, mark them with `@pytest.mark.slow` or `@pytest.mark.integration`
|
||||
- Aim for high test coverage of new code
|
||||
|
||||
## Pull Requests
|
||||
|
||||
### Creating a Pull Request
|
||||
|
||||
1. Ensure your code passes all tests and pre-commit hooks
|
||||
2. Push your changes to your fork
|
||||
3. Submit a pull request to the main repository
|
||||
4. Follow the pull request template
|
||||
|
||||
## Documentation
|
||||
|
||||
- Update docstrings for new or modified functions, classes, and methods
|
||||
- Use Google-style docstrings:
|
||||
|
||||
```python
|
||||
def function_name(param1: type, param2: type) -> return_type:
|
||||
"""Short description.
|
||||
Longer description if needed.
|
||||
|
||||
Args:
|
||||
param1: Description of param1
|
||||
param2: Description of param2
|
||||
|
||||
Returns:
|
||||
Description of return value
|
||||
|
||||
Raises:
|
||||
ExceptionType: When and why this exception is raised
|
||||
"""
|
||||
```
|
||||
|
||||
- Update README.md for user-facing changes
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you need help with your contribution:
|
||||
|
||||
- Open an issue for discussion
|
||||
- Reach out to the maintainers
|
||||
- Check existing code for examples
|
||||
|
||||
Thank you for contributing to Windows-MCP!
|
||||
@@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 CursorTouch
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,6 +1,6 @@
|
||||
<div align="center">
|
||||
|
||||
<h1>🪟 Windows-Use</h1>
|
||||
<h1>🪟 Windows Use Autonomous Agent</h1>
|
||||
|
||||
<a href="https://github.com/CursorTouch/windows-use/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
|
||||
Reference in New Issue
Block a user