diff options
| author | Victor Shyba <victor.shyba@gmail.com> | 2015-03-12 16:29:00 -0300 |
|---|---|---|
| committer | Victor Shyba <victor.shyba@gmail.com> | 2015-03-12 16:29:00 -0300 |
| commit | 319cdeaf95ec305108b243c2725d2df204e1355b (patch) | |
| tree | 9e28ed5f93828d054b65617730d864169e84a2d5 | |
| parent | 787f6ffaa5cbac73d7966dd9a58e158bcf382c90 (diff) | |
For #311, fixing some parts
Titles, link to platform, couple of missing commands and small typos.
| -rw-r--r-- | README.md | 21 |
1 files changed, 11 insertions, 10 deletions
@@ -10,37 +10,38 @@ The Pixelated User Agent is the mail client of the Pixelated ecosystem, it is co  -## Getting started for development +## Getting started ### Registering with a provider -First of all, you should have an account on a LEAP/Pixelated provider with email support. + * You can create a developer account at our [Dev Provider](https://dev.pixelated-project.org/). * There are some other LEAP providers on the [Bitmask page](https://bitmask.net), but they don't support email currently. + * If you want to run your own provider, see [pixelated-platform](https://github.com/pixelated-project/pixelated-platform). -### Instructions -Requirements: +### Requirements * vagrant * virtualbox Clone the repository: git clone https://github.com/pixelated-project/pixelated-user-agent.git + cd pixelated-user-agent -From the root folder, set up the vagrant machine: +From the project root folder, set up the vagrant machine: vagrant up source You can log into the machine and view project root folder with: vagrant ssh -From here on you can run the tests for the UI by going to the **web-ui** folder or for the API by going to the **service** folder and running: +From here on you can run the tests for the UI by going to the **web-ui** folder or for the API by going to the **service** folder: cd /vagrant/web-ui ./go test cd /vagrant/service ./go test -You can also run the mail client with: +Running the user agent: ``` $ pixelated-user-agent --host 0.0.0.0 @@ -53,11 +54,11 @@ username ******************* ``` -As soon as the agent start you will be asked for username, password and the [provider you registered with](https://github.com/pixelated-project/pixelated-user-agent/blob/master/README.md#registering-with-a-provider). +As soon as the agent starts you will be asked for username, password and the [provider you registered with](https://github.com/pixelated-project/pixelated-user-agent/blob/master/README.md#registering-with-a-provider). -Then point your browser to [http://localhost:3333](http://localhost:3333) to see it running. +Now you can see it running on [http://localhost:3333](http://localhost:3333) -## Getting started as an user +##Debian package 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: |