summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDuda Dornelles <dudassdornelles@gmail.com>2014-08-22 18:47:57 -0300
committerDuda Dornelles <dudassdornelles@gmail.com>2014-08-22 18:47:57 -0300
commit5437c359f83ddd2d3dbeb853631fd528e2739feb (patch)
treea01ed72df0efb6418d76e06040aa3be10f5b1d8e /README.md
parentdbeb4cf410c00280495b5aa767ca84bed55b66b9 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 08bf0ac0..7f131f41 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,18 @@ The User Agent is composed of 2 components:
- The Web Ui, which is the the HTML, CSS and JS files served to the browser; and
- The Service component, which is the web service that serves the Web Ui to the browser, provides the REST API which the the Web Ui uses, and integrates with the LEAP or Pixelated provider.
+## Quickstart
+
+Dependencies are: node, npm, ruby, bundle, virtualenv, git
+
+Once you have that, run:
+
+```
+curl https://raw.githubusercontent.com/pixelated-project/pixelated-user-agent/master/install-pixelated.sh | /bin/bash
+```
+
+_____________
+
## Web Ui
The Web Ui needs to generate the templates and CSS to be served. For that, you need (from inside `./web-ui`) to run the command `./go build` at least once after downloading the code. From here on, you can run `./go watch` to auto-generate the resources as they are changed.