William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-22 21:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Mark Qvist 2020-04-27 13:43:20 +02:00
parent e9cfbb1118
commit 1b5e9e3699
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -3,3 +3,6 @@
testutils testutils
TODO TODO
Examples/RNS Examples/RNS
build
dist
rns*.egg-info

8
README.md
View File

@ -54,7 +54,13 @@ Some countries still ban the use of encryption when operating under an amateur r
## How do I get started? ## How do I get started?
Full documentation and video tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you really want to experiment already, you could take a look in the "Examples" folder, for some well-documented example programs. Be sure to also read the [Reticulum Overview Document](http://unsigned.io/wp-content/uploads/2018/04/Reticulum_Overview_v0.4.pdf). Full documentation and video tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you really want to experiment already, you could take a look in the "Examples" folder, for some well-documented example programs. Be sure to also read the [Reticulum Overview Document](http://unsigned.io/wp-content/uploads/2018/04/Reticulum_Overview_v0.4.pdf).
To install dependencies and get started: If you just need Reticulum as a dependency for another application, the easiest way is probably via pip:
```bash
pip3 install rns
```
For development, you might want to get the latest source from GitHub. To install dependencies and get started:
```bash ```bash
# Install dependencies # Install dependencies