me/neoq
1
0
Fork 0
mirror of https://github.com/acaloiaro/neoq synced 2026-07-21 10:12:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README updates

Browse source
This commit is contained in:
Adriano Caloiaro 2024-01-26 09:00:01 -07:00 committed by Adriano Caloiaro
parent 99f07276b6
commit cce17b8e08
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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
@ -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.