wymiller/DrillSergeant
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Wyatt J. Miller 2022-12-27 21:50:12 -06:00
parent e156eef14c
commit 922678b223
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -74,6 +74,14 @@ To get a commit report to a PDF file filtered by the `devel` branch:
drillsergeant -o pdf -b devel drillsergeant -o pdf -b devel
``` ```
To get a tally based on a directory:
```bash
drillsergeant -f /home/user/drillsergeant
```
This also works on enviroment variables too!
Got too many contributors to fit onto your terminal? Run this by installing [bat](https://github.com/sharkdp/bat): Got too many contributors to fit onto your terminal? Run this by installing [bat](https://github.com/sharkdp/bat):
```bash ```bash
@ -143,7 +151,7 @@ Then, you can find the binary in the `publish/` directory. You can move this exe
## Known Issues ## Known Issues
- A user must be in the root of a git project in order for this program to run. - A user must be in the root of a git project in order for this program to run (unless the user runs the `-f` flag when invoking `drillsergeant`).
## Next Steps/Contributing ## Next Steps/Contributing