inclusive-design#29 Add information for running/building the site

edited readme.md
TeddTech · Jan 31, 2020 · 3c10bcb · 3c10bcb
1 parent 03e6370
commit 3c10bcb
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 12 deletions.
diff --git a/Pipfile b/Pipfile
diff --git a/README.md b/README.md
@@ -1,4 +1,26 @@
 # wecount.inclusivedesign.ca
-The source files for the WeCount site
+The source files for the WeCount site.
+
+## How to Run
+
+To run the website locally enter the following in command line terminal:
+
+```
+npm run dev
+```
+## How to Build
+
+To build static webpages enter the following in command line terminal:
+
+```
+nuxt generate
+```
+
+The static html files will be in the newly formed `dist` directory.
+
+## How to Deploy
+
+This repository is hooked to netlify. Updating the master branch will trigger a rebuild and deployement of the project to this temporary [url](https://peaceful-davinci-07d6a2.netlify.com/)
+
 
 <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.