giers10/auto-git-gui
1
0
Fork 0
Code Releases Activity

auto-git:

Browse Source 
[change] README.md
This commit is contained in:
Victor Giers
2025-06-01 09:33:39 +02:00
parent 9e509fae9e
commit 7bdd7344fb
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -15,17 +15,15 @@
Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compilation. Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compilation.
## Features ## Features
- Monitors changes in your Git repositories. - Monitors selected git repositories for changes.
- Automatically generates commit messages using a Large Language Model (LLM). - Automatically generates commit messages using a Large Language Model (LLM).
- Compiles README.md files for your projects. - Compiles and updates the `README.md` file based on the project's source code.
## Usage ## Installation
### Installation
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/your-repo/auto-git.git git clone https://github.com/victorgiers/auto-git.git
cd auto-git cd auto-git
@@ -39,10 +37,12 @@ Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compi
npm start npm start
### Configuration ## Usage
- Configure your Git repositories in the `settings.json` file. 1. Open the application.
- Set up your preferred LLM model and other parameters. 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 ## License