From 1b5e9e36995beeb0c49c6ca0aacf4a714cf11426 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 27 Apr 2020 13:43:20 +0200 Subject: [PATCH] Updated readme --- .gitignore | 3 +++ README.md | 8 +++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 95ca0f7..b74ad7a 100755 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,6 @@ testutils TODO Examples/RNS +build +dist +rns*.egg-info \ No newline at end of file diff --git a/README.md b/README.md index 9f5aa41..4d6b5e0 100755 --- a/README.md +++ b/README.md @@ -54,7 +54,13 @@ Some countries still ban the use of encryption when operating under an amateur r ## 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). -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 # Install dependencies