From 1ecc17292b654cfa2a544bd3f9dc592930dcbca2 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Sun, 14 Nov 2021 13:45:32 +0100 Subject: [PATCH] docs: add a development section to the readme Signed-off-by: Mark Sagi-Kazar --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 6ae2a7b0..5af31625 100644 --- a/README.md +++ b/README.md @@ -124,3 +124,15 @@ Please see our [security policy](.github/SECURITY.md) for details about reportin [go-oidc]: https://github.com/coreos/go-oidc [issue-1065]: https://github.com/dexidp/dex/issues/1065 [release-notes]: https://github.com/dexidp/dex/releases + +## Development + +When all coding and testing is done, please run the test suite: + +```shell +make testall +``` + +For the best developer experience, install [Nix](https://builtwithnix.org/) and [direnv](https://direnv.net/). + +Alternatively, install Go and Docker manually or using a package manager. Install the rest of the dependencies by running `make deps`.