Skip to content

Commit

Permalink
remove nix-shell section from CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaechus committed Nov 11, 2024
1 parent 6367886 commit 8f0d307
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,3 @@
- Take part in troubleshooting and testing
- Star the repo
- Follow the maintainers

## Development with nix

When you develop with nix you can use the [dev shell](https://github.com/pystardust/ani-cli#nix-shell).

To run the dev shell you can run the following command in the repository root:
```shell
nix-shell
```

The dev shell includes the following packages:
- runtime dependencies of ani-cli
- shfmt
- shellcheck

Its also possible to use alternative packages for the video player or add features with this command:
```shell
nix-shell --arg <feature> true
```
These are the packages available in the dev shell:
- `withVlc`
- `withIina`
- `chromecastSupport`
- `syncSupport`

Just chain these commands together when you wanna multiple features for example:
```shell
nix-shell --arg withVlc true --arg chromecastSupport true
```

0 comments on commit 8f0d307

Please sign in to comment.