auto-git-gui/README.md

auto-git-gui

Author: Unknown

⚠️ This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!

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

Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compilation.

Features

• Monitors selected git repositories for changes.
• Automatically generates commit messages using a Large Language Model (LLM).
• Compiles and updates the README.md file based on the project's source code.

Installation

1. Clone the repository:

   git clone https://github.com/victorgiers/auto-git.git
   cd auto-git
   
   
   

2. Install dependencies:

   npm install
   
   
   

3. Start the application:

   npm start
   
   
   

Usage

1. Open the application.
2. Add your git repositories to be monitored.
3. Configure settings such as LLM model and author details.
4. Let Auto-Git handle commit messages and README compilation.

License

This project is licensed under the MIT License.

MIT License

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.