summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-04-23 10:20:33 -0600
committermo khan <mo@mokhan.ca>2025-04-23 10:20:33 -0600
commit41be7375c59d840810d00129171dec034a6177d2 (patch)
tree71b935af489c0f193c6b0b6eea789599bbef087d
parente170683dbab2e993546043952f2e2bb1d1fd1107 (diff)
docs: improve the getting started section
-rw-r--r--README.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/README.md b/README.md
index f45cc9e..341d8d5 100644
--- a/README.md
+++ b/README.md
@@ -41,8 +41,23 @@ The Authorization team is researching ways to evolve GitLab's authorization stac
- [make](https://www.gnu.org/software/make/)
- [docker](https://docs.docker.com/get-started/get-docker/)
-```bash
-$ make setup
-$ make test
-$ make run
-```
+1. Install tools:
+ ```bash
+ $ make setup
+ ```
+2. Run the tests:
+ ```bash
+ $ make test
+ ```
+4. Copy the `.env` file
+ ```bash
+ $ cp .env .env.local
+ ```
+5. Edit the settings in the `.env.local` file:
+ ```bash
+ $ vim .env.local
+ ```
+6. Start the service
+ ```bash
+ $ make run
+ ```