From 5dc07a42bfe49e01b564d22660db7484560820ea Mon Sep 17 00:00:00 2001 From: Victor Giers Date: Sun, 1 Jun 2025 14:04:21 +0200 Subject: [PATCH] Update README.md with detailed GitCat application information and features --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b4724d..bed4f10 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ -# Projekt in auto-git-gui +# auto-git-gui + +**Author:** Unknown + +> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!** + +# GitCat + +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. + +## Features + +- **Interactive Cat Mascot**: A cute cat character that provides feedback and assistance during git operations. +- **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. +- **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. +- **Customizable Settings**: Adjust various settings such as sky mode, autostart, and commit thresholds. + +## Installation + +1. Download the latest release from the [Releases page](https://github.com/your-repo/gitcat/releases). +2. Run the installer for your operating system (Windows, macOS, Linux). + +## Usage + +- **Add a Folder**: Click on "Add Folder" to select and add a git repository. +- **Monitor Folders**: Select a folder to monitor its changes and view commit history. +- **Commit Changes**: Use the intelligent committing feature or manually commit changes with custom messages. +- **Generate README**: Automatically generate a README file for your repository using AI models. +- **Push to Gitea**: Connect your repositories with a Gitea server and push commits directly. + +## Settings + +- **Sky Mode**: Toggle between light and dark themes. +- **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. +- **Intelligent Commit Thresholds**: Set file change or time-based thresholds for automatic committing. + +## 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. \ No newline at end of file