From 237f11fdac25ff730b851ec498d8f3f7e225c23b Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sat, 30 Mar 2024 10:01:33 +0100 Subject: [PATCH 1/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22cc39a..cf578df 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ 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) @@ -54,7 +54,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...) ``` 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 # Why? From 94bcd490fa72b817dabad39133cdfd9da4364187 Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sat, 30 Mar 2024 10:03:54 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index cf578df..ffe0009 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ Once downloaded you need to create an alias for your shell guides found below: [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: +``` +export author_file='path/to/your/aurhor.txt' +``` [Powershell guide for env variable](https://stackoverflow.com/a/714918) you can now run it using the alias shorthand you assigned to it From 46f1313283b5297618e372ccfe953a2456fd076c Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sat, 30 Mar 2024 10:04:32 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffe0009..51eb24f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Once downloaded you need to create an alias for your shell guides found below: [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: +For bash you just need to add this to your .bashrc file: ``` export author_file='path/to/your/aurhor.txt' ``` From 124273ce1b6a078719ed8d587300ee69bd218b19 Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sat, 30 Mar 2024 10:08:16 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 51eb24f..25f3a36 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ 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: ``` From 87a95a38b2bf38116df925d7606dd74edae48066 Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Sat, 30 Mar 2024 10:08:49 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 25f3a36..61f7968 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ 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^* +*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: