all repos — searchix @ 7ad48953a4d9470d2f4fe89343c0b09bff410c58

Search engine for NixOS, nix-darwin, home-manager and NUR users

chore: initial commit

Alan Pearce
commit

7ad48953a4d9470d2f4fe89343c0b09bff410c58

1 file changed, 35 insertions(+), 0 deletions(-)

changed files
A README.md
@@ -0,0 +1,35 @@
+# Searchix + +## Development + +### Pre-requisites + +- [Nix (the package manager)](https://nixos.org/download/) +- Optional: + - [cachix](https://docs.cachix.org/installation#installation) + - [lorri](https://github.com/nix-community/lorri) + - [direnv](https://direnv.net/) + +### Setup + +1. Optional: use cachix to avoid building some tools + + ```shell-session + cachix use pre-commit-hooks + ``` + +2. Start a nix shell (this will take some time) + + ```shell-session + nix-shell + ``` + +3. Optional: install and set up lorri and use `lorri shell` instead of `nix-shell` + +4. Optional: install direnv, integrate it with your shell and then run + + ```shell-session + ln -s .envrc.sample .envrc + ``` + + Now `nix-shell` or `lorri shell` will be run for you automatically when you `cd` into this directory.