diff options
| author | Micah Lee <micah@micahflee.com> | 2020-08-24 19:56:34 -0400 |
|---|---|---|
| committer | Micah Lee <micah@micahflee.com> | 2020-08-24 19:56:34 -0400 |
| commit | 50ae9945359fc88cae7c428f5f7f52b77ac47aa3 (patch) | |
| tree | 7ed37b2d8939d1dba005d883173f05d983e937f2 /docs/source/index.rst | |
| parent | b3b09a6f2caa5c940184f6f127cfc19513ff09f0 (diff) | |
| download | onionshare-50ae9945359fc88cae7c428f5f7f52b77ac47aa3.tar.gz onionshare-50ae9945359fc88cae7c428f5f7f52b77ac47aa3.zip | |
Add some OnionShare styling to the theme and write some more docs
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 6a371419..5df79ed0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,11 +3,30 @@ How to Use OnionShare OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network. +Getting Started +--------------- + +Install in Windows or macOS +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can always get the latest version of OnionShare for Windows or macOS from `onionshare.org <https://onionshare.org/>`_. + +And you can find old versions of OnionShare at https://onionshare.org/dist/. + +Install in Linux +^^^^^^^^^^^^^^^^ + +There are various ways to install OnionShare for Linux, but the recommended way is to use the Flatpak package. Flatpak ensures that you'll always use the most latest dependencies and run OnionShare inside of a sandbox. + +Make sure you have ``flatpak`` installed and the Flathub repository added by following `these instructions <https://flatpak.org/setup/>`_ for your Linux distribution. Then install OnionShare from Flathub by following `the instructions here <https://flathub.org/apps/details/org.onionshare.OnionShare>`_. + +Documentation +------------- + .. toctree:: :maxdepth: 2 - install - how_it_works + features advanced security develop |