From 7373dc5e66172901f5c9c52c724988e26fe7d159 Mon Sep 17 00:00:00 2001 From: mateoclarke Date: Fri, 13 Dec 2024 16:42:42 -0500 Subject: [PATCH] make README a bit more beginner friendly and avert secrets sharing --- .gitignore | 1 + README.md | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c987e98c1..8c92cb05c 100644 --- a/.gitignore +++ b/.gitignore @@ -71,6 +71,7 @@ build-iPhoneSimulator/ # Let's not track any csv, env or log files *.csv *.env +*.env.local *.log *.xml diff --git a/README.md b/README.md index b843ef5e1..d39a721df 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,14 @@ The helper script, `vision-zero`, makes it easy to spin up your local Vision Zer 1. Create a new Python environment and install the packages in [requirements.txt](requirements.txt). -2. Save a copy of the [environment template (`env_template)](env_template) as `.env`, and populate your database read replica credentials. +```shell +# Example for Mac +python -m venv venv +source venv/bin/activate +pip install -r requirements.txt +``` + +2. Save a copy of the [environment template (`env_template`)](env_template) as `.env`, and populate your database read replica credentials. ```shell RR_USERNAME=""