alemi/gitts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: added README.md

Browse source
This commit is contained in:
əlemi 2024-02-09 19:51:55 +01:00
parent 1ad66a9ff1
commit bc5d54a984
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,4 +1,24 @@
# gitts # gitts
**git tui stats** is a terminal application to display git project informations **git tui stats** is a terminal application to display git project informations
It's currently very work in progress, but shows a line chart with contributions per week per commit author ![the simplest gitts view, shoutout to mumble-web](https://cdn.alemi.dev/proj/gitts/gitts-basic-mumble-web.png)
## about this
gitts displays statistics about contributors of your git repository in your terminal
this is inspired by github's Insights>Contributors view, which is a cool way to gaze at the current state of a project
gitts aims to give such informations directly in the cli, in different forms
## installation
just
```
$ CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --git https://git.alemi.dev/gitts.git
```
by default it gets bundled both ratatui (tui library) and egui (gui library) to provide both views
it's possible to pick just one (or neither) of them with `--no-default-features --features=tui,gui`
### screenshot
![tui screenshot, shoutout to zola](https://cdn.alemi.dev/proj/gitts/gitts-tui-zola.png)