diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 56 |
1 files changed, 52 insertions, 4 deletions
@@ -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 +``` |