This commit is contained in:
Theis
2024-04-20 22:11:14 +02:00
+7 -1
View File
@@ -16,13 +16,19 @@ Currently tested in:
# How to run
Download the binary for your OS on the [release page](https://github.com/Slug-Boi/cocommit/releases)
Once downloaded you need to create an alias for your shell guides found below:
[Bash Guide](https://linuxize.com/post/how-to-create-bash-aliases/)
[Bash Guide for alias](https://linuxize.com/post/how-to-create-bash-aliases/)
*^please note if you use another shell than bash you will need to look up how to do it in that shell^*
[Powershell Guide for alias](https://stackoverflow.com/questions/24914589/how-to-create-permanent-powershell-aliases)
Once you've created an alias for the program you need to set an env variable (author_file) in your shell. This should be the path pointing to your author.txt file
For bash you just need to add this to your .bashrc file:
```
export author_file='path/to/your/aurhor.txt'
```
[Powershell guide for env variable](https://stackoverflow.com/a/714918)
*Please note that the syntax line at the top of the author.txt file should not be deleted and that you must add at least one author to the file to run the program*
you can now run it using the alias shorthand you assigned to it
## Usage:
```