aboutsummaryrefslogtreecommitdiff
path: root/desktop/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2022-04-03 11:15:53 -0700
committerMicah Lee <micah@micahflee.com>2022-04-03 11:15:53 -0700
commit3fd96cd472c81e3a765b79adc0bcd104c4da42fe (patch)
treef76829485f28fb6a2c0ffbeb0a807ec38c964dd5 /desktop/README.md
parentee9a5269bb45499772a904616c7585f5318bf320 (diff)
downloadonionshare-3fd96cd472c81e3a765b79adc0bcd104c4da42fe.tar.gz
onionshare-3fd96cd472c81e3a765b79adc0bcd104c4da42fe.zip
Combine all get-tor scripts into a single get-tor.py
Diffstat (limited to 'desktop/README.md')
-rw-r--r--desktop/README.md46
1 files changed, 13 insertions, 33 deletions
diff --git a/desktop/README.md b/desktop/README.md
index af6a83f1..31071782 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -9,62 +9,42 @@ git clone https://github.com/onionshare/onionshare.git
cd onionshare/desktop
```
-Make sure you have Python 3 installed. If you're using Windows or macOS, install version 3.9.9 [from python.org](https://www.python.org/downloads/release/python-3912/). For Windows, make sure to install the 32-bit (x86) version, and to check the box to add python to the path on the first page of the installer.
+Make sure you have Python 3 installed. If you're using Windows or macOS, install version 3.9.12 [from python.org](https://www.python.org/downloads/release/python-3912/). For Windows, make sure to check the box to add python to the path on the first page of the installer.
-Make sure you have [poetry installed](https://python-poetry.org/docs/#installation), and then install the dependencies:
+Make sure you have [poetry](https://python-poetry.org/) installed:
-```sh
-poetry install
```
-
-In Windows, you may need to install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), making sure to check "Desktop development with C++", before `poetry install` will work properly.
-
-### Install platform-specific dependencies
-
-#### Linux
-
-In Ubuntu 20.04 you need the `libxcb-xinerama0` package installed.
-
-Download Tor Browser and extract the binaries:
-
-```sh
-poetry run ./scripts/get-tor-linux.py
+pip3 install poetry
```
-#### macOS
-
-Download Tor Browser and extract the binaries:
+And install the poetry dependencies:
```sh
-poetry run ./scripts/get-tor-osx.py
+poetry install
```
-#### Windows
+**Windows users:** You may need to install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), making sure to check "Desktop development with C++", before `poetry install` will work properly.
-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 Tor
-Download and install 7-Zip from https://7-zip.org/download.html. I downloaded `7z1900.exe`. Add `C:\Program Files (x86)\7-Zip` to your path.
+**Linux users:** In Ubuntu 20.04 you need the `libxcb-xinerama0` package installed.
+
+**Windows users:** Download and install 7-Zip from https://7-zip.org/download.html. [Add](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53) `C:\Program Files (x86)\7-Zip` to your path.
Download Tor Browser and extract the binaries:
```sh
-poetry run python scripts\get-tor-windows.py
+poetry run python ./scripts/get-tor.py
```
### Compile dependencies
-Install Go. The simplest way to make sure everything works is to install Go by following [these instructions](https://golang.org/doc/install). (In Windows, make sure to install the 32-bit version of Go, such as `go1.17.5.windows-386.msi`.)
+Install Go. The simplest way to make sure everything works is to install Go by following [these instructions](https://golang.org/doc/install).
Download and compile `meek-client`:
```sh
-./scripts/build-meek-client.py
-```
-
-Or in Windows:
-
-```powershell
-python .\scripts\build-meek-client.py
+poetry run python ./scripts/build-meek-client.py
```
### Running OnionShare from the source code tree