tcsenpai/devlog
1
0
Fork 0
mirror of https://github.com/tcsenpai/devlog.git synced 2025-06-06 02:05:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
tcsenpai 2024-08-30 16:16:40 +02:00
parent 7b717a8eb7
commit c382ed89c4
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,7 +1,17 @@
# Devlog # Devlog
![Devlog](./devlog.png)
Devlog is a powerful tool that automatically generates (b)log posts from your Git commit history, providing a natural language summary of your development progress. Devlog is a powerful tool that automatically generates (b)log posts from your Git commit history, providing a natural language summary of your development progress.
It uses [ollama](https://github.com/ollama/ollama) to generate the blog posts locally so it never sends your data to third-party servers.
## Requirements
- [ollama](https://github.com/ollama/ollama) capable of running llama3
- [git](https://git-scm.com/)
- [python](https://www.python.org/)
## Description ## Description
Devlog retrieves all the commit messages in a repository (local or remote), groups them by customizable time periods, and generates blog posts in natural language. This tool is perfect for developers who want to maintain a development log or changelog without the manual effort of writing blog posts. Devlog retrieves all the commit messages in a repository (local or remote), groups them by customizable time periods, and generates blog posts in natural language. This tool is perfect for developers who want to maintain a development log or changelog without the manual effort of writing blog posts.

BIN
devlog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 235 KiB