summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno Wagner Gonçalves <bwgpro@gmail.com>2015-02-03 11:35:07 -0200
committerBruno Wagner Gonçalves <bwgpro@gmail.com>2015-02-03 11:35:07 -0200
commitab6955b3fbc5b89ad80fcade0702b54efb9ef682 (patch)
tree855ef10ebabf434966d988d0377bdf8c9a807136
parente7127dc234e35a16d28520fbcaad7c9b6d46a087 (diff)
Simplified the quickstart instructions
-rw-r--r--README.md27
1 files changed, 19 insertions, 8 deletions
diff --git a/README.md b/README.md
index c4821c23..7aa3d061 100644
--- a/README.md
+++ b/README.md
@@ -16,28 +16,39 @@ The User Agent has 2 components:
## Quickstart
-### Using Vagrant
+Requirements:
-to install from source:
+ * vagrant
+ * virtualbox
- vagrant up
+Clone the repository:
-or
+ git clone git@github.com:pixelated-project/pixelated-user-agent.git
+
+From the root folder, set up the vagrant machine:
vagrant up source
+
+You can log into the machine using:
+
+ vagrant ssh
-to install using the pixelated prvidede debian packages:
+then you can run with:
- vagrant up deb
+ pixelated-user-agent --host 0.0.0.0
+and it's done!
-### Installing dependencies for development:
-Dependencies are: node, npm, compass (ruby), virtualenv, git
+## Long version
+
+### The dependencies for development are:
+node, npm, compass (ruby), virtualenv, git
* debian/ubuntu:
* `sudo apt-get update`
* `sudo apt-get install git nodejs-legacy npm python-dev python-virtualenv libffi-dev g++ ruby-dev`
* `sudo gem install compass`
+
* MacOS:
Using brew will get you there faster:
* `brew install node ruby phantomjs gnupg`