aboutsummaryrefslogtreecommitdiff
path: root/desktop/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-10-14 22:36:31 -0700
committerMicah Lee <micah@micahflee.com>2020-10-14 22:36:31 -0700
commit50e7471a49600c1788cc823a07781e724137a93c (patch)
tree88c8557682bf92414de4a972e49f5608f69e0369 /desktop/README.md
parent6bc085922badf26075af4f7ff8c448bfe454e175 (diff)
downloadonionshare-50e7471a49600c1788cc823a07781e724137a93c.tar.gz
onionshare-50e7471a49600c1788cc823a07781e724137a93c.zip
Make it work in Windows
Diffstat (limited to 'desktop/README.md')
-rw-r--r--desktop/README.md36
1 files changed, 31 insertions, 5 deletions
diff --git a/desktop/README.md b/desktop/README.md
index 96306cf4..71f3082f 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -2,6 +2,13 @@
## Building OnionShare
+Start by getting the source code and changing to the `desktop` folder:
+
+```sh
+git clone https://github.com/micahflee/onionshare.git
+cd onionshare/desktop
+```
+
### Install platform-specific dependencies
#### Linux
@@ -12,15 +19,27 @@ If you're using Linux, install `tor` and `obfs4proxy` from either the [official
#### Windows
-### Prepare the code
+These instructions include adding folders to the path in Windows. To do this, go to Start and type "advanced system settings", and open "View advanced system settings" in the Control Panel. Click Environment Variables. Under "System variables" double-click on Path. From there you can add and remove folders that are available in the PATH.
-Get the source code and change to the `desktop` folder:
+Download Python 3.8.6, 32-bit (x86) from https://www.python.org/downloads/release/python-386/. I downloaded `python-3.8.6.exe`. When installing it, make sure to check the "Add Python 3.8 to PATH" checkbox on the first page of the installer.
+
+Download and install 7-Zip from http://www.7-zip.org/download.html. I downloaded `7z1900.exe`. Add `C:\Program Files (x86)\7-Zip` to your path.
+
+Install dependencies:
-```sh
-git clone https://github.com/micahflee/onionshare.git
-cd onionshare/desktop
+```
+pip install requests
+```
+
+Download Tor Browser and extract the binaries by running:
+
+```
+cd ..\cli
+python scripts\get-tor-windows.py
```
+### Prepare the code
+
OnionShare uses [Briefcase](https://briefcase.readthedocs.io/en/latest/).
Install Briefcase dependencies by following [these instructions](https://docs.beeware.org/en/latest/tutorial/tutorial-0.html#install-dependencies).
@@ -32,6 +51,13 @@ python3 -m venv venv
. venv/bin/activate
```
+Or in Windows:
+
+```
+python -m venv venv
+venv\Scripts\activate.bat
+```
+
While your virtual environment is active, install briefcase from pip.
```