From a9870e7198ec9efc6c9bb9b17c0da22e0678d4a1 Mon Sep 17 00:00:00 2001 From: Victor Giers Date: Sun, 1 Jun 2025 08:15:00 +0200 Subject: [PATCH] auto-git: [change] README.md --- README.md | 89 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 53 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 30d26cf..45d43ae 100644 --- a/README.md +++ b/README.md @@ -4,52 +4,69 @@ > ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!** -# Repository Manager +# Auto-Git + +**Author:** Victor Giers + +> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!** ## Description -Repository Manager is a desktop application designed to help users manage their Git repositories efficiently. It provides features such as adding folders, monitoring repository updates, generating README files, and more. + +Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compilation. ## Features -- **Add Folders**: Easily add new folders to be monitored. -- **Monitor Repositories**: Automatically check for updates in selected repositories. -- **Generate README**: Generate or update README.md files for your projects. -- **Snapshot Commits**: Save snapshots of specific commits for backup or review. -- **Checkout Commits**: Switch between different commits within a repository. -- **Commit Changes**: Commit changes directly from the application (feature pending). -- **Tray Integration**: Manage repositories via system tray notifications and actions. - -## Installation -1. Download the latest release from the [Releases](https://github.com/yourusername/repository-manager/releases) page. -2. Extract the downloaded archive to your desired location. -3. Run the executable file to start the application. +- Monitors changes in your Git repositories. +- Automatically generates commit messages using a Large Language Model (LLM). +- Compiles README.md files for your projects. ## Usage -- **Add a Folder**: Click on the `+` button in the sidebar to add a new folder. -- **Select a Folder**: Click on a folder in the sidebar to view its commits and other details. -- **Generate README**: Click on the "Generate README" or "Update README" button to create or update a README.md file for the selected repository. -- **Snapshot a Commit**: Click on the snapshot icon next to a commit to save it as a backup. -- **Checkout a Commit**: Click on the checkout icon next to a commit to switch to that version of the repository. -## Contributing -Contributions are welcome! Please follow these steps: -1. Fork the repository. -2. Create your feature branch (`git checkout -b feature/AmazingFeature`). -3. Commit your changes (`git commit -m 'Add some AmazingFeature'`). -4. Push to the branch (`git push origin feature/AmazingFeature`). -5. Open a pull request. +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/your-repo/auto-git.git + cd auto-git + + +2. Install dependencies: + ```bash + npm install + + +3. Start the application: + ```bash + npm start + + +### Configuration + +- Configure your Git repositories in the `settings.json` file. +- Set up your preferred LLM model and other parameters. ## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -## Acknowledgements -- Thanks to all contributors and users who have supported this project. -- Special thanks to Electron for providing the framework to build cross-platform desktop applications. +This project is licensed under the MIT License. -## Contact -For any questions or feedback, please contact us at: -- Email: your.email@example.com -- GitHub: [yourusername](https://github.com/yourusername) ---- +MIT License -**Note**: This README is a template and should be customized according to your specific project details. \ No newline at end of file +Copyright (c) 2023 Victor Giers + +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. \ No newline at end of file