Skip to content
This repository has been archived by the owner on Feb 15, 2018. It is now read-only.

Commit

Permalink
Bugs/readme (#11)
Browse files Browse the repository at this point in the history
* Trying pandoc rst generationi

* Trying to make it work

* Add upgrade documentation
  • Loading branch information
madninja committed Sep 21, 2016
1 parent 0482485 commit 26248f0
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ python:
- "2.7"
- "3.5"

before_install:
- sudo apt-get install -qq pandoc

install:
- pip install tox-travis
- pip install coveralls
Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
include LICENCE.txt
include README.rst
include README.md
include version.txt
include CONTRIBUTORS.md
include CONTRIBUTING.md
Expand Down
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@ Helium Commander makes it easy to talk to the [Helium API](https://docs.helium.c
## Installation


### From Source

Use this if you're actively developing or extending Commander:

```
$ virtualenv env
$ source env/bin/activate
$ pip install -e .
```

### From PyPi

From [PyPi](https://pypi.python.org). Use this if you want to use the command line tool on its own.
Expand All @@ -40,6 +30,26 @@ Note that on some systems you may have to use `sudo` to install the package syst
$ sudo pip install helium-commander
```

To upgrade from a previous version:

```
$ pip install helium-commander --upgrade -I
```

**Note**: Ensure that you use `-I` to allow clean upgrades of packages


### From Source

Use this if you're actively developing or extending Commander:

```
$ virtualenv env
$ source env/bin/activate
$ pip install -e .
```


### Nix

`helium-commander` can also be installed using the [Nix](https://nixos.org/nix/) package manager. Clone the repository and run:
Expand Down

0 comments on commit 26248f0

Please sign in to comment.