pogmommy/zellij
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(contributing): add a small nix section (#1172)

Browse source
This commit is contained in:
a-kenji 2022-03-04 16:33:42 +01:00 • committed by GitHub
parent 5108bed936
commit 8a9fb73791
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -45,6 +45,20 @@ version `wasm-opt --version` > 97, for it's command `wasm-opt`.
To run `test`, you will need the package `pkg-config` and a version of `openssl`. To run `test`, you will need the package `pkg-config` and a version of `openssl`.
<details>
<summary>Should you be a nix (linux/macOs) user, you can use the following
commands in order to get set up: (expand)</summary>
- `nix develop`
Download and set up dependencies.
- `nix build`
Build the binary in the `result` directory. (--release)
- `nix run`
Run the binary.
- `cachix use zellij`
Will use our binary cache as a substituter.
</details>
## Running the end-to-end tests ## Running the end-to-end tests
Zellij includes some end-to-end tests which test the whole application as a black-box from the outside. Zellij includes some end-to-end tests which test the whole application as a black-box from the outside.
These tests work by running a docker container which contains the Zellij binary, connecting to it via ssh, sending some commands and comparing the output received against predefined snapshots. These tests work by running a docker container which contains the Zellij binary, connecting to it via ssh, sending some commands and comparing the output received against predefined snapshots.
@ -59,6 +73,7 @@ These tests work by running a docker container which contains the Zellij binary,
5. `export CARGO_TARGET_X86_64_UNKNOWN_LINUX_MUSL_LINKER=$CC_x86_64_unknown_linux_musl` 5. `export CARGO_TARGET_X86_64_UNKNOWN_LINUX_MUSL_LINKER=$CC_x86_64_unknown_linux_musl`
</details> </details>
To run these tests locally, you'll need to have either `docker` or `podman` and also `docker-compose` installed. To run these tests locally, you'll need to have either `docker` or `podman` and also `docker-compose` installed.
Once you do, in the repository root: Once you do, in the repository root: