Skip to content

Commit 1905beb

Browse files
authored
Update README.md
1 parent e079b9a commit 1905beb

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,27 @@
33

44
This is a Python script designed to read git diff output and leverage Ollama to generate commit messages for each file. When you run this script, commits will be automatically created for all staged files.
55

6+
<img src="https://github.com/user-attachments/assets/f39344db-10c5-4dbc-a3e6-2ce275d52004" />
7+
68
### Installation
79

8-
- [Python Ollama](https://github.com/ollama/ollama-python)
9-
- [Olama Server](https://ollama.com/download)
10+
- [Olama](https://ollama.com/download)
11+
1012
- [Ollama Model](https://ollama.com/library/gemma3)
1113

1214
This script currently uses the `gemma3:4b` model.
1315

16+
```
17+
ollama run gemma3:4b
18+
```
19+
20+
- [Python Ollama](https://github.com/ollama/ollama-python)
21+
```
22+
pip install ollama
23+
```
24+
25+
26+
1427
### Usage
1528

1629
Place the `auto_commit.py` file in the root directory of your project.
@@ -20,6 +33,9 @@ If ollama server is running, run the script using the command
2033
python3 auto_commit.py
2134
```
2235

36+
37+
38+
2339
### Miscellaneous
2440

2541
Contributions and ideas are welcome, such as:

0 commit comments

Comments
 (0)