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
Brian Warner
91269d18b1
README: Add codecov.io badge
2016-03-02 14:42:19 -08:00
Brian Warner
101ac4c1af
switch to tox for running tests
2016-02-27 14:39:56 -08:00
Brian Warner
59da5d74a2
README: minor improvements
2016-01-12 15:03:55 -08:00
Brian Warner
12816c16d8
README: installation may need some libraries
2015-12-08 15:05:16 -08:00
Brian Warner
085b28f97d
README: mention new send-directory feature
2015-12-03 17:02:34 -06:00
Brian Warner
80603aaa32
finish py3/async support, needs Twisted >= 15.5.0
...
The latest Twisted fixes the web.Agent code we need for proper async
support. There's still a daemonization bug that prevents 'wormhole
server start' from succeeding (it hangs).
2015-12-01 00:15:24 -06:00
Brian Warner
f8fdec18a5
stop testing py2.6, since Twisted no longer supports it
...
README.md: stop claiming compatibility with it.
2015-11-29 01:42:15 -06:00
Brian Warner
3457360751
update docs for 0.6.0 release
2015-11-23 17:14:07 -08:00
Vikas Parashar
79471dff7c
Updated README.md with Installation instruction
...
Instruction for installation were missing so updated with `pip install` method.
2015-10-12 17:44:36 -07:00
Brian Warner
03566b3ed4
update docs for 0.5.0 release
2015-10-07 17:10:48 -07:00
Brian Warner
e7e5c2d079
merge send/receive "file" and "text" into a single command
2015-10-03 22:45:43 -07:00
Brian Warner
4cd838f410
README: add travis badge (for 'master')
2015-09-28 16:23:19 -07:00
Brian Warner
efd6d27cc6
rename SymmetricWormhole to just "Wormhole"
...
Update docs too. Now both blocking/ and twisted/ use "Wormhole".
2015-07-24 17:47:46 -07:00