Commit Graph

68 Commits

Author SHA1 Message Date
Brian Warner
8ea67f6015 README: move repo, switch to GitHub Actions for CI 2021-01-10 15:08:13 -08:00
Brian Warner
f175feba91 README: update python-version compatibility note
We still run CI against py2.7 and py3.5, but Cryptography has deprecated
both, so it might stop working if/when they make a non-compatible change.
2021-01-10 15:05:38 -08:00
Brian Warner
95a628e1a7 docs: add pointers to server code and setup instructions
Thanks to @kaie for the suggestion.

Closes #387
2020-05-21 21:11:40 -07:00
Brian Warner
2420150794 README/setup.py: update to reflect py3.8 compatibility 2020-04-04 14:25:47 -07:00
Brian Warner
048a9e392a README: add repology.org packaged-versions table 2019-11-08 10:34:33 -08:00
Brian Warner
8cfdc4c9bc README: drop python3.4 support
Python3.4 is no longer maintained (PEP 429 says March 2019 was the EOL date),
and the current version of pip (19.1) is the last to support it, so it's time
to let go.

* remove py34 from .travis.yml so PRs don't fail spuriously (there's some
  problem with txtorcon and twisted that only happens on py3.4)
2019-07-05 15:50:00 -07:00
Brian Warner
777c963c9a README: note py37 compatibility 2018-07-27 14:46:13 -07:00
Brian Warner
323044e9f5 stop supporting py3.4 on windows
Python.org is still supporting 3.4, but the lastest pypiwin32 stopped
providing binary wheels for windows for 3.4, so we can't run the appveyor CI
tests any more. It might still work there, but you'll have to find a way to
build pypiwin32 yourself.

We still support py3.4 on non-windows platforms.
2018-02-26 17:23:27 -08:00
Brian Warner
be41563ef4 README: fix pypi badge: we're magic-wormhole, not zfec 2018-02-17 19:37:25 -08:00
Brian Warner
dfca0209b3 README: add PyPI badge 2018-02-17 19:36:45 -08:00
Brian Warner
08e911e1f3 README: add readthedocs badge 2017-11-12 15:43:50 -08:00
Brian Warner
3f3be8c7aa move most of README into docs, add more pointers 2017-11-12 15:21:56 -08:00
Brian Warner
a4cca39c0e README: add appveyor status badge (windows tests) 2017-11-02 11:44:55 -07:00
Brian Warner
155e3b5398 README: expand git install, explain --user/venv install options
refs #249
2017-09-12 22:52:00 -07:00
Brian Warner
0a762c5bfd README: mention 'sudo' for install commands
refs #249
2017-09-12 17:13:07 -07:00
Brian Warner
80f6e8ef90 expand on compile-on-windows instructions 2017-09-03 14:10:08 -07:00
Buckaroo9
d9b47c4f84 Added Other Requirement for Installing on Windows.
Microsoft Visual C++ 9.0 is required for installation. Otherwise large errors are show when executing pip install magic-wormhole.
2017-09-03 14:08:04 -07:00
Brian Warner
50a1df386e README: mention github and IRC channel 2017-08-11 14:31:28 -07:00
Leo Arias
97b194ccd8 Fix the xkcd link markup 2017-06-30 12:51:28 -06:00
Brian Warner
fc1bf4f141 README: minor reformatting, move tox down to Development 2017-06-29 15:49:34 -07:00
Pablo Oliveira
7088b0eb27 improve installation instructions
Added separated subsections for each OS (OS X, Linux, Windows) on the installation guide.
2017-06-29 15:45:59 -07:00
Brian Warner
532e0b5f55 Merge PR199 2017-06-29 07:52:05 -07:00
Brian Warner
1ed3ab003e README: more updates 2017-06-29 07:50:10 -07:00
lanzelot1989
9d5a049424 Add relevant xkcd 2017-06-28 20:47:20 +02:00
Quentin Hibon
79f1d3bd0e Update README.md
Update Debian and Ubuntu installation instructions
2017-06-28 14:01:12 +02:00
Brian Warner
572f6e3c16 NEWS: update for 0.10.0 release 2017-06-24 15:59:48 +01:00
Alex Gaynor
cf3c641e81 Mention brew installation in the readme 2017-05-27 13:48:01 -04:00
Brian Warner
598ab8b62a drop py3.3 support, since new txtorcon imports asyncio on py3
py3.3 is pretty rare in the wild anyways
2017-05-24 17:31:43 -07:00
Kenneth Reitz
285fd5bef4 Update README.md 2017-05-24 08:40:43 -07:00
Atul Varma
0765a567ff Add development instructions. 2017-05-23 19:43:18 -04:00
Atul Varma
cfc6e44d68 Make footnotes section an HTML comment
I noticed that the footnotes section appears as a visible heading when rendered as HTML (e.g. in GitHub), which looks odd because there's nothing below it, so I thought it might be useful to wrap it in an HTML comment so it's only seen by those who view it in its text form.  Feel free to close this PR if you disagree though!
2017-01-04 18:58:58 -05:00
Brian Warner
361952fdd9 README: improve Fedora-specific installation hints
refs #120
2016-12-29 13:52:25 -05:00
Brian Warner
1882e51a3b README: note py3.6 compatibility 2016-12-29 13:51:40 -05:00
Brian Warner
636fc94840 README: rewrap, update windows/py3 note. 2016-12-26 16:19:29 -05:00
xloem
2b049ac7c6 Missing build dependency 2016-12-26 16:19:29 -05:00
Brian Warner
64cdd426c0 README: remove the py3-daemon-is-broken message
It seems to work now, with the current Twisted (at least 16.6.0, possibly
older ones too).

closes #67
2016-12-23 23:05:46 -05:00
Brian Warner
0ff14bf4d0 README: mention python-pip
Thanks to @grempe for the catch. Refs #89.
2016-11-11 17:06:13 -08:00
Ofekmeister
a3fc7b9402 update link to PyCon video
confirmation of re-upload
https://www.youtube.com/watch?v=dgnikoiau68&lc=z13czfvrwuepzr0jl04cezmyiznzgtohi0g.1466623963397520
2016-10-23 14:48:27 -04:00
Daniel Kahn Gillmor
eb46656244 wormhole-server needs a hyphen 2016-07-31 19:50:28 -04:00
Brian Warner
5542545165 CLI: move most top-level args down into the subcommand
So instead of "wormhole --verify send", use "wormhole send --verify".

The full set of arguments that were moved down:

* --code-length=
* --verify
* --hide-progress
* --no-listen
* --tor

The following remain as top-level arguments (which should appear after
"wormhole" and before the subcommand):

* --relay-url=
* --transit-helper=
* --dump-timing=
* --version
2016-07-27 17:56:03 -07:00
Brian Warner
894e00bea1 README: add link to PyCon video 2016-07-27 16:53:18 -07:00
Brian Warner
3b03593b9c README: add example
closes #65
2016-07-27 16:51:01 -07:00
Brian Warner
f0c32617d0 README: mention libsodium-dev package
pynacl-1.0.1 has a bug, on systems which have the sodium runtime library
installed (/usr/lib/libsodium.so, as provided by a package like
"libsodium13"), but not the development headers (/usr/include/sodium.h,
as provided by "libsodium-dev"). The pynacl setup.py tries to detect
whether a system libsodium can be used (instead of the bundled copy), by
using cffi to load libsodium.so and check the version strings. However
this test doesn't check that sodium.h is available, which is needed to
build the glue code.

The long-term fix is to change pynacl, either to improve the test (to
look for a header file, which sounds tricky), or to always use the
bundled sodium unless explicitly told otherwise (removing the test
altogether). The short term fix is to tell magic-wormhole builders to
install libsodium-dev if they run into this error, or use the
environment-variable override when installing.

closes #10

refs https://github.com/pyca/pynacl/issues/184
2016-06-23 11:31:24 -07:00
Francois Marier
1170f196b3 Add missing install to Debian instructions 2016-06-06 19:01:55 -07:00
Brian Warner
b6ff5f3946 README: mention build-essential
I keep forgetting that nothing automatically depends upon it.
2016-06-03 18:27:20 -07:00
laharah
74b4a10ac1 Windows build and CI patch
a compressed patch to apply new settings for the windows build
and allows appveyor to execute tox tests correctly
2016-06-03 16:12:55 -07:00
laharah
db0d1c5013 updated readme to include windows installation instructions 2016-06-02 16:23:48 -07:00
Brian Warner
228302c501 add link to PyCon slides 2016-05-31 17:44:26 -07:00
Brian Warner
0ecf37a923 README: notes for Fedora and OS-X
Thanks to @gtank for the suggestions.
2016-05-30 23:57:08 -07:00
Brian Warner
06d2a0be68 update docs 2016-05-25 20:58:53 -07:00