72 lines
2.1 KiB
Markdown
72 lines
2.1 KiB
Markdown
# 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 changes in your Git repositories.
|
|
- Automatically generates commit messages using a Large Language Model (LLM).
|
|
- Compiles README.md files for your projects.
|
|
|
|
## Usage
|
|
|
|
### 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.
|
|
|
|
|
|
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. |