summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRussell Currey <ruscur@russell.cc>2019-05-01 13:16:43 +1000
committerDaniel Axtens <dja@axtens.net>2019-05-03 16:09:19 +1000
commit1b363a7884ef7daadc313063a26ff3d32e38a5ce (patch)
treeb6713bdc9aa0be4ab7c9546d94fdd6fca98363c3 /README.rst
parent7a20ccda99e48dab643d1fbd7e170fe3e4c47185 (diff)
downloadpatchwork-1b363a7884ef7daadc313063a26ff3d32e38a5ce.tar
patchwork-1b363a7884ef7daadc313063a26ff3d32e38a5ce.tar.gz
README: add .env file to installation instructions
Creating the .env file is mentioned in the installation documentation but not in the README, so following only the steps mentioned there will fail. Add this and add a `cd patchwork` in there for good measure so you could straight up copy paste the steps. Signed-off-by: Russell Currey <ruscur@russell.cc> Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 38c1847..b45c3e6 100644
--- a/README.rst
+++ b/README.rst
@@ -61,11 +61,16 @@ environment. To install Patchwork:
$ git clone https://github.com/getpatchwork/patchwork.git
-3. Build the images. This will download over 200MB from the internet::
+3. Create a ``.env`` file in the root directory of the project and store your
+ ``UID`` attribute there::
+
+ $ cd patchwork && echo "UID=$UID" > .env
+
+4. Build the images. This will download over 200MB from the internet::
$ docker-compose build
-4. Run `docker-compose up`::
+5. Run `docker-compose up`::
$ docker-compose up