From ab6955b3fbc5b89ad80fcade0702b54efb9ef682 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bruno=20Wagner=20Gon=C3=A7alves?= Date: Tue, 3 Feb 2015 11:35:07 -0200 Subject: Simplified the quickstart instructions --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) (limited to 'README.md') 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` -- cgit v1.2.3