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

docs: change readme to include install script commands

Browse Source
This commit is contained in:
Slug-Boi
2024-12-01 22:28:38 +01:00
parent 495606d798
commit 6ffb08c561
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -1
View File
@@ -14,13 +14,25 @@
## Install: ## Install:
### Install Script
The repo contains two different install scripts for unix based system and window. You can copy paste one of the commands below to use it.
**Unix:**
```
$ curl -L -o install.sh https://github.com/Slug-Boi/cocommit/raw/refs/heads/main/installer/install.sh && chmod +x install.sh && ./install.sh
```
**Windows:**
*The windows script is untested so please let me know if it works and use at your own risk*
```
$ Invoke-WebRequest -Uri https://github.com/Slug-Boi/cocommit/raw/refs/heads/main/installer/install.ps1 -OutFile install.ps1; .\install.ps1
```
### Go Install
It should be possible to install the program using the go install command: It should be possible to install the program using the go install command:
``` ```
$ go install github.com/Slug-Boi/cocommit $ go install github.com/Slug-Boi/cocommit
``` ```
You will more than likely have to add the binary to your PATH after the fact if your go bin directory is not in your PATH already. Or you can create an alias to it using the instructions below. You will more than likely have to add the binary to your PATH after the fact if your go bin directory is not in your PATH already. Or you can create an alias to it using the instructions below.
### Manual Binary Install
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 for alias](https://linuxize.com/post/how-to-create-bash-aliases/) [Bash Guide for alias](https://linuxize.com/post/how-to-create-bash-aliases/)