Update README with new features and author information
This commit is contained in:
23
README.md
23
README.md
@@ -1,20 +1,20 @@
|
|||||||
# auto-git-gui
|
# auto-git-gui
|
||||||
|
|
||||||
**Author:** Unknown
|
**Author:** Victor Giers
|
||||||
|
|
||||||
> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!**
|
> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!**
|
||||||
|
|
||||||
# GitCat
|
# Auto-Git
|
||||||
|
|
||||||
GitCat is a unique and interactive desktop application designed to help you manage your git repositories with ease. It features a playful cat mascot that guides you through various git operations, making the process more engaging and user-friendly.
|
Auto-Git is a unique and interactive desktop application designed to help you manage your git repositories with ease. It features a playful cat mascot that guides you through various git operations, making the process more engaging and user-friendly.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Interactive Cat Mascot**: A cute cat character that provides feedback and assistance during git operations.
|
- **Interactive Cat Mascot**: A cute cat character that provides feedback and assistance during git operations.
|
||||||
|
- **Intelligent Committing**: Set thresholds for automatic committing based on file changes or time intervals.
|
||||||
|
- **Readme Generation**: Automatically generate README files for your repositories using AI models (such as this one!).
|
||||||
- **Folder Management**: Easily add, remove, and select git folders to monitor.
|
- **Folder Management**: Easily add, remove, and select git folders to monitor.
|
||||||
- **Commit History**: View commit history with detailed diffs and options to revert or checkout commits.
|
- **Commit History**: View commit history with detailed diffs and options to revert or checkout commits.
|
||||||
- **Intelligent Committing**: Set thresholds for automatic committing based on file changes or time intervals.
|
|
||||||
- **Readme Generation**: Automatically generate README files for your repositories using AI models.
|
|
||||||
- **Push to Gitea**: Push your commits directly to a Gitea server with ease.
|
- **Push to Gitea**: Push your commits directly to a Gitea server with ease.
|
||||||
- **Customizable Settings**: Adjust various settings such as sky mode, autostart, and commit thresholds.
|
- **Customizable Settings**: Adjust various settings such as sky mode, autostart, and commit thresholds.
|
||||||
|
|
||||||
@@ -37,15 +37,4 @@ GitCat is a unique and interactive desktop application designed to help you mana
|
|||||||
- **Autostart**: Enable or disable GitCat to start automatically on system boot.
|
- **Autostart**: Enable or disable GitCat to start automatically on system boot.
|
||||||
- **Close to Tray**: Minimize GitCat to the system tray instead of closing it completely.
|
- **Close to Tray**: Minimize GitCat to the system tray instead of closing it completely.
|
||||||
- **Intelligent Commit Thresholds**: Set file change or time-based thresholds for automatic committing.
|
- **Intelligent Commit Thresholds**: Set file change or time-based thresholds for automatic committing.
|
||||||
|
- **Set your AI model**: Default is qwen2.5-coder:7b for Commit Message inference and qwen2.5-coder:32b for README.md generation
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to the project.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
GitCat is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Note**: Replace `https://github.com/your-repo/gitcat/releases` with the actual URL of your repository's releases page if different.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user