Skip to content

Commit

Permalink
docs(README.md): compilation and completion
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur91f committed May 13, 2024
1 parent da0f7a7 commit db98357
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,18 @@ find a deeper insight on

## Get started

- **1. Get exeiac binary**
- **1. Get exeiac binary and install completion**
```bash
go install github.com/arthur91f/exeiac/src/exeiac/src/exeiac@main
asdf plugin add golang https://github.com/asdf-community/asdf-golang.git
asdf install golang 1.19
git clone https://github.com/arthur91f/exeiac.git
cd exeiac/
asdf local golang 1.19
go install src/exeiac
```
- bash completion: `cp './src/completion/scripts/exeiac.sh' '/usr/share/bash-completion/completions/exeiac'`
- zsh completion: `cp './src/completion/scripts/exeiac.zsh' '/usr/share/zsh/site-functions/_exeiac'`
- fish completion: `cp './src/completion/scripts/exeiac.fish' '/usr/share/fish/vendor_completions.d/exeiac.fish'`

- **2. Write your modules** in whatever language you want. A module can be seen
as a makefile to deploy your brick. Basically, it's a shell script that
Expand Down

0 comments on commit db98357

Please sign in to comment.