From 262f161f42c4e59beec41c6f440336c38385426a Mon Sep 17 00:00:00 2001
From: Marc Coquand <marc@mccd.space>
Date: Wed, 20 Dec 2023 20:46:00 -0600
Subject: Initial commit

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 52 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3c15303..cc1a4ff 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,54 @@
-# Bloop Ann
+# Fixgen - 0 dependency language independent fixture generator
 
-## Prerequisites
+This tool allows you to very easily generate fixtures.
 
-- Nix
-- Direnv
+## Development - Prerequisites
+
+- [Nix](https://nixos.org/manual/nix/stable/installation/installing-binary)
+- [Direnv](https://direnv.net/docs/installation.html)
+
+After installation, you will need to run direnv allow
+
+```
+direnv allow
+```
+
+For it to work.
+
+### VSCode
+
+You'll need OCaml platform and direnv extension. Once you have those, you will need to start the project from the terminal. First, ensure you have setup code terminal command:
+
+https://code.visualstudio.com/docs/setup/mac
+
+Once in place, cd to the project and run
+
+```
+code .
+```
+
+And VSCode should launch correctly with LSP installed.
+
+### Running development
+
+```
+./scripts/run-watch.sh
+```
+
+Run tests
+
+```
+./scripts/run-test-watch.sh
+```
+
+You can also run them manually:
+
+```
+dune runtests
+```
+
+### Building
+
+```
+dune build
+```
-- 
cgit v1.2.3