https://github.com/shaunakgh/gitmd
An ai-powered README/blog/writeup generator made with rust
https://github.com/shaunakgh/gitmd
ai ai-powered blog-generator cli github-repository markdown markdown-generator ollama ollama-cli readme-generator rust rust-lang
Last synced: 7 months ago
JSON representation
An ai-powered README/blog/writeup generator made with rust
- Host: GitHub
- URL: https://github.com/shaunakgh/gitmd
- Owner: shaunakgh
- Created: 2025-03-23T18:25:11.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-04-02T10:58:11.000Z (7 months ago)
- Last Synced: 2025-04-02T11:35:07.903Z (7 months ago)
- Topics: ai, ai-powered, blog-generator, cli, github-repository, markdown, markdown-generator, ollama, ollama-cli, readme-generator, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.txt
Awesome Lists containing this project
README
============ gitmd ============
An ai-powered README/blog/writeup
generator for git projects
made with rust
============ setup ============
Prerequisites:
==============
If you haven't already, install rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
and restart your terminal session.
Then, install the ollama application and cli
at https://ollama.com/download
Since this program runs llama3.2 ai by default, run this command:
ollama run llama3.2
once finished installing the model, exit with ctrl-d§
NOTE that this model will be 2.0gb
Installing
==========
Run this command in your terminal session:
git clone https://github.com/shfroom/gitmd.git && cd gitmd && cargo install --path .
Then, run this command to see if it has installed
successfully:
gitmd
If it returns this:
error: the following required arguments were not provided:
<--readme|--blog|--writeup>
Usage: gitmd <--readme|--blog|--writeup>
For more information, try '--help'.
Congrats 🎉! Gitmd is installed on your computer.
============ usage ============
gitmd -p PATH -m MODEL -r/-b/-w
where:
OPTIONAL
-p or --path is the absolute path to your git repo.
DEFAULTS TO current directory
-m or --model is the model
DEFAULTS TO llama3.2
MANDATORY
-r/-b/-w for README, blog or writeup