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 99f0727 commit cce17b8
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +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:
To enter the development shell, run `nix develop --impure`. If `devenv` is installed, this step is not necessary; simply
enter the neoq directory after having run `direnv allow`.

## Running services for tests

Expand All @@ -157,6 +156,12 @@ devenv up

This runs Postgres and Redis in the foreground. In a separate terminal, run `make test` to run the test suite.

## Running tests

Before submitting pull requests, always run tests locally with after having run `devenv up`.

Run `make test` to run the test suite.

# Status

This project is currently pre-1.0. Future releases may change the API.

0 comments on commit cce17b8

Please sign in to comment.