summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-01-26 13:41:13 +0100
committerGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-01-26 13:41:13 +0100
commitedbef77114dfde33524dccb22d27144570299372 (patch)
tree8fea3920a4312a90e5eddd7607dc7b35de5fdb61
parentf9fbf70170421fc5e02b95923ff137e0234cad69 (diff)
Add config instructions to README
-rw-r--r--README.md4
-rw-r--r--sample_config.json3
2 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 22a173ae..84ed0e99 100644
--- a/README.md
+++ b/README.md
@@ -14,5 +14,7 @@ Run the following commands from this directory to fetch dependencies and compile
```
$ yarn
-$ gulp
+$ gulp --config=config.json
```
+
+**Note:** You need to replace `config.json` with the name / path of a real config file. This config file can be created by making a copy of the `sample_config.json` template and replacing the entries with your setup data. Make sure not to check this new config file into the VCS, as it is unique to each deployment situation.
diff --git a/sample_config.json b/sample_config.json
new file mode 100644
index 00000000..628476ed
--- /dev/null
+++ b/sample_config.json
@@ -0,0 +1,3 @@
+{
+ "GOOGLE_OAUTH_CLIENT_ID": "the-google-oauth-client-id"
+}