Merge pull request #15 from digital-science/update-devs-readme

Update devs readme
digital-science · Jun 10, 2024 · b9dbc29 · b9dbc29
2 parents 98db4f0 + 10a3c36
commit b9dbc29
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README_DEVS.md b/README_DEVS.md
@@ -2,6 +2,16 @@
 
 Various useful tips for running the API LAB in development mode.
 
+## Setup
+
+Before trying to do any development work, you will need to create a `set-envs.sh` file in the `tools` folder.
+
+The purpose of this file is to define the local directories you would like to use for building test and staging versions of site, to ensure the site renders as expected before pushing to production.
+
+Example directories are given in `tools/set-envs-sample.sh`. Replace the values for the stated variables with those you desire.
+
+Note the `.gitignore` file is set to ignore `set-envs.sh`.
+
 ## Workflow
 
 ### 1. Adding new notebooks