docs-improvements
continuous-integration/drone/push Build is passing Details

Reviewed-on: #237
This commit is contained in:
moritz 2023-11-23 20:08:18 +00:00
commit b67dab1299
2 changed files with 8 additions and 3 deletions

View File

@ -10,10 +10,11 @@ Install [direnv](https://direnv.net), run `cp .envrc.sample .envrc`, then run `d
Install [Go >= 1.16](https://golang.org/doc/install) and then:
- `make build` to build
- `make build` to build. If this fails, run `go mod tidy`.
- `./abra` to run commands
- `make test` will run tests
- `make install` will install it to `$GOPATH/bin`
- `make install-abra` will install abra to `$GOPATH/bin`
- `make install-kadabra` will install kadabra to `$GOPATH/bin`
- `go get <package>` and `go mod tidy` to add a new dependency
Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/.drone.yml) runs a number of checks on each pushed commit. See the [Makefile](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/Makefile) for more handy targets.

View File

@ -4,7 +4,7 @@ title: Install
!!! warning
We've seen reports that `abra` under [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) doesn't work due to an underlying bug in Docker context handling. See [`coop-cloud/organising#406`](https://git.coopcloud.tech/coop-cloud/organising/issues/406) and [`docker/for-win#13180`](https://github.com/docker/for-win/issues/13180) for more.
02/2023: We've seen reports that `abra` under [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) doesn't work due to an underlying bug in Docker context handling. See [`coop-cloud/organising#406`](https://git.coopcloud.tech/coop-cloud/organising/issues/406) and [`docker/for-win#13180`](https://github.com/docker/for-win/issues/13180) for more. However, this might be fixed with newer versions of Docker.
## Stable release
@ -18,6 +18,10 @@ curl https://install.abra.coopcloud.tech | bash
curl https://install.abra.coopcloud.tech | bash -s -- --rc
```
## Compile from source
Follow the guide [here](https://docs.coopcloud.tech/abra/hack/)
## Installer script source
You can view that [here](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer).