Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
acaloiaro committed Jan 26, 2024
1 parent b0bea93 commit 5312699
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,17 @@ and run tests.

## Automatic setup and teardown

`direnv` is used to let neoq automatically configure its own dev environment. This includes installing dependencies and
developer tooling.

See [installing direnv](https://direnv.net/docs/installation.html) if you want the dev environment setup to be automated.

`direnv allow` allows `direnv` to automatically setup all tooling and dependencies in a development shell upon entering
the neoq directory.

## Manual setup and teardown

Neoq uses `devenv` to manage development environments and services.

To enter the development shell, run `nix develop --impure`.

In order to run the test suite, the required services need to be started. Start services by running the following:

## Running services for tests

The neoq development shell gives you the `devenv` executable.
Expand Down

0 comments on commit 5312699

Please sign in to comment.