From 3b86ef8579da867d7a249cd299866f02e816ce21 Mon Sep 17 00:00:00 2001 From: Erica Marigold Date: Sun, 16 Feb 2025 17:16:17 +0530 Subject: [PATCH] chore(README): update contributing docs nix command to use user shell --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e766b42..fe5f9c1 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ print("Total size:", stats.totalSize, "bytes") This library requires at least Luau [0.629](https://github.com/luau-lang/luau/releases/tag/0.629) (specifically requires leading `|`, `buffer` built-in and `idiv` operator support). ## Contributing -Contributions are heavily welcomed! We use Nix Flakes for management a reproducible development environment. To get started, run `exec nix develop`, after [installing Nix](https://nixos.wiki/wiki/Nix_Installation_Guide). This is recommended for tests to be consistent, since we rely on `InfoZIP` implementations as sanity checks, although different distributions supply differently patched versions of it. +Contributions are heavily welcomed! We use Nix Flakes for management a reproducible development environment. To get started, run `exec nix develop -c $SHELL`, after [installing Nix](https://nixos.wiki/wiki/Nix_Installation_Guide). This is recommended for tests to be consistent, since we rely on `InfoZIP` implementations as sanity checks, although different distributions supply differently patched versions of it. - We utilize [pesde](https://pesde.dev) for package management. Run `pesde install` to install all dependencies. - Before submitting a pull request, make sure you include comprehensive test cases for new features, and make sure all tests pass. Tests can be run with `lune run tests`. Refer to other test suites for examples of how to write your own tests.