Slug.Boi/cocommit
1
0
Fork 0
mirror of https://github.com/Slug-Boi/cocommit.git synced 2026-05-13 20:55:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/Slug-Boi/cocommit

Browse Source
This commit is contained in:
Theis
2024-04-20 22:11:14 +02:00
parent 9b9fe278d6 87a95a38b2
commit 4738a58f0b
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -2
View File
@@ -16,13 +16,19 @@ Currently tested in:
# How to run # How to run
Download the binary for your OS on the [release page](https://github.com/Slug-Boi/cocommit/releases) 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: 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^* *^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) [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 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) [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 you can now run it using the alias shorthand you assigned to it
## Usage: ## Usage:
``` ```
@@ -54,7 +60,7 @@ The syntax for the author file can be found at the top of the template file incl
name_short|Name|Username|email (opt: |ex) (opt: ;;group1 or ;;group1|group2|group3...) name_short|Name|Username|email (opt: |ex) (opt: ;;group1 or ;;group1|group2|group3...)
``` ```
opt explained: opt explained:
ex -> excludes the given author for all and negation commands ex -> excludes the given author for all and negation commands
group -> groups an author which can then be called as an argument to add all people from that group. An author can be a part of multiple groups group -> groups an author which can then be called as an argument to add all people from that group. An author can be a part of multiple groups
# Why? # Why?