diff --git a/README.md b/README.md index d073057f..2a15051f 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,8 @@ Feel free to dive in, contributions are welcomed! Open an issue or submit PRs. ### Linting and formatting -`nim-codex` uses [nph](https://github.com/arnetheduck/nph) for formatting our code and it is requrired to adhere to its styling. +`nim-codex` uses [nph](https://github.com/arnetheduck/nph) for formatting our code and it is required to adhere to its styling. If you are setting up fresh setup, in order to get `nph` run `make build-nph`. In order to format files run `make nph/`. -If you want you can install Git pre-commit hook using `make install-nph-commit`, which will format modified files prior commiting them. +If you want you can install Git pre-commit hook using `make install-nph-commit`, which will format modified files prior committing them. If you are using VSCode and the [NimLang](https://marketplace.visualstudio.com/items?itemName=NimLang.nimlang) extension you can enable "Format On Save" (eq. the `nim.formatOnSave` property) that will format the files using `nph`. \ No newline at end of file diff --git a/nix/default.nix b/nix/default.nix index 691e2af3..b5823f86 100644 --- a/nix/default.nix +++ b/nix/default.nix @@ -56,7 +56,7 @@ in pkgs.gcc13Stdenv.mkDerivation rec { fakeCargo ]; - # Disable CPU optmizations that make binary not portable. + # Disable CPU optimizations that make binary not portable. NIMFLAGS = "-d:disableMarchNative -d:git_revision_override=${revision}"; # Avoid Nim cache permission errors. XDG_CACHE_HOME = "/tmp";