open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: minor reformatting, move tox down to Development

Browse Source
This commit is contained in:
Brian Warner 2017-06-29 15:49:34 -07:00
parent 7088b0eb27
commit fc1bf4f141
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -54,8 +54,8 @@ Received file written to README.md
### OS X ### OS X
On OS X, you may need to install `pip` and On OS X, you may need to install `pip` and run `$ xcode-select --install` to
run `$ xcode-select --install` to get GCC. get GCC.
Or with `homebrew`: Or with `homebrew`:
@ -70,28 +70,25 @@ On Debian 9 and Ubuntu 17.04+ with `apt`:
On previous versions of the Debian/Ubuntu systems, or if you want to install On previous versions of the Debian/Ubuntu systems, or if you want to install
the latest version, you may first need: the latest version, you may first need:
`$ apt-get install python-pip build-essential python-dev libffi-dev libssl-dev`. `$ apt-get install python-pip build-essential python-dev libffi-dev libssl-dev`
On Fedora: On Fedora:
`$ dnf install python-pip python-devel libffi-devel openssl-devel gcc-c++ `$ dnf install python-pip python-devel libffi-devel openssl-devel gcc-c++
libtool redhat-rpm-config`. libtool redhat-rpm-config`.
Note: If you get errors like `fatal error: sodium.h: No such file or directory` on Note: If you get errors like `fatal error: sodium.h: No such file or
Linux, either use `SODIUM_INSTALL=bundled pip install magic-wormhole`, or try directory` on Linux, either use `SODIUM_INSTALL=bundled pip install
installing the `libsodium-dev` / `libsodium-devel` package. These work around magic-wormhole`, or try installing the `libsodium-dev` / `libsodium-devel`
a bug in pynacl which gets confused when the libsodium runtime is installed package. These work around a bug in pynacl which gets confused when the
(e.g. `libsodium13`) but not the development package. libsodium runtime is installed (e.g. `libsodium13`) but not the development
package.
### Windows ### Windows
On Windows, python2 may work On Windows, python2 may work better than python3. On older systems, `$ pip
better than python3. On older systems, `$ pip install --upgrade pip` may install --upgrade pip` may be necessary to get a version that can compile all
be necessary to get a version that can compile all the dependencies. the dependencies.
Developers can clone the source tree and run `tox` to run the unit tests on
all supported (and installed) versions of python: 2.7, 3.4, 3.5, and 3.6.
## Motivation ## Motivation
@ -225,6 +222,7 @@ pip install -e .[dev]
### Running Tests ### Running Tests
Within your virtualenv, the command-line program `trial` will Within your virtualenv, the command-line program `trial` will
run the test suite: run the test suite:
@ -241,6 +239,10 @@ import notation, e.g.:
trial wormhole.test.test_cli.PregeneratedCode.test_file_tor trial wormhole.test.test_cli.PregeneratedCode.test_file_tor
``` ```
Developers can also just clone the source tree and run `tox` to run the unit
tests on all supported (and installed) versions of python: 2.7, 3.4, 3.5, and
3.6.
### Troubleshooting ### Troubleshooting
Every so often, you might get a traceback with the following Every so often, you might get a traceback with the following