From 7ad48953a4d9470d2f4fe89343c0b09bff410c58 Mon Sep 17 00:00:00 2001
From: Alan Pearce
Date: Thu, 2 May 2024 13:55:48 +0200
Subject: chore: initial commit

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6cf90d
--- /dev/null
+++ b/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.
-- 
cgit 1.4.1