summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruno Wagner Gonçalves <bwgpro@gmail.com>2015-02-12 12:02:22 -0200
committerBruno Wagner Gonçalves <bwgpro@gmail.com>2015-02-12 12:02:22 -0200
commitc89983e82f69e915e6a62dab0b4610c789a9914c (patch)
treef72dc84765756fb7cc557eefa932010993528edb /README.md
parent1b7a10b5643d7d833df2fb5627921fedde1ceaa2 (diff)
Update README.md
Removed long start and rephrased some sections
Diffstat (limited to 'README.md')
-rw-r--r--README.md79
1 files changed, 4 insertions, 75 deletions
diff --git a/README.md b/README.md
index 7cb2554c..85402cfb 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,14 @@
Pixelated User Agent
====================
-This contains the Pixelated User Agent, which is composed of a web UI written as a JavaScript single page app, and a service that provides a REST-ful interface that the UI can use for all User Agent actions. For now, all of these actions are mail-related but this might evolve later. The default service is written to talk to a Pixelated or LEAP provider.
+The Pixelated User Agent is the mail client of the Pixelated ecosystem, it is composed of two parts, a web interface written in javascript and an API written in python that glues that interface with the Pixelated or LEAP Provider.
>**The Pixelated User Agent is still in early development state!**
>Some things may not yet work the way you expect it to.
>Setting up the service is still rather troublesome and so far it only serves limited functionality.
-
-# Running it
-The User Agent has 2 components:
-* The Web Ui, which is the the HTML, CSS and JS files served to the browser;
-* The Service component, which is the web service that serves the Web UI to the browser, provides the REST API which the Web Ui uses, and integrates with the LEAP or Pixelated provider.
-
-## Quickstart
+## Getting started for development
Requirements:
@@ -39,74 +33,9 @@ then you can run with:
and it's done!
-## 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`
- * `sudo gem install compass`
- * `sudo easy_install virtualenv`
-
-### Installing the app and running in development mode
-
-* Next step is cloning the repository with `git clone https://github.com/pixelated-project/pixelated-user-agent.git`
-
-* Enter the folder `pixelated-user-agent`
-
-* Run the setup `./install-pixelated.sh`
-
-* After it finishes, you can activate the virtualenv with `source service/.virtualenv/bin/activate`
-
-* The user agent will be available with the command `pixelated-user-agent`, running it you will be prompted for the credentials and the user agent will be started at localhost:3333
-
----
-
-## Service
-
-* Enter the `service` folder
-
-* Create the virtualenv with `virtualenv .virtualenv`
-
-* Activate it with `source .virtualenv/bin/activate`
-
-* Install the test dependencies with `pip install -r test_requirements.txt`
-
-* Run the setup with `python setup.py develop`
-
-* Then, to run use `pixelated-user-agent` on the command line
-
-> You need an account in a Leap provider with support for email to test pixelated,
-> if you don't have one yet, you can register with the following command
-pixelated-user-agent --register your.provider.org desired_account
-
-## Web Ui
-
-* Enter the `web-ui` folder
-
-* Run:
-```
-$ npm install
-$ ./node_modules/bower/bin/bower install
-$ ./go build
-```
-
-The Web Ui needs to generate the html and CSS to be served, that's why you need to 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.
-
-And that's it.
-
----
-
-## Installing the debian package
+## Getting started as an user
-The debian package is currently only available in our [repository](http://packages.pixelated-project.org/debian/). To use it you have to add it to your sources list:
+For people that just want to try the user agent, we have debian packages available in our [repository](http://packages.pixelated-project.org/debian/). To use it you have to add it to your sources list:
```shell