diff options
author | Micah Lee <micah@micahflee.com> | 2020-11-01 10:13:58 -0800 |
---|---|---|
committer | Micah Lee <micah@micahflee.com> | 2020-11-01 10:13:58 -0800 |
commit | 208d615ad0d1bda60723a40d09f1b2ca2cd5bcfe (patch) | |
tree | 2df68d03a32e6c37e5c330ec3a8e1f4db7ffe8ec /desktop | |
parent | 7ece466d823ed876589071b4f652c4e6f89b1483 (diff) | |
download | onionshare-208d615ad0d1bda60723a40d09f1b2ca2cd5bcfe.tar.gz onionshare-208d615ad0d1bda60723a40d09f1b2ca2cd5bcfe.zip |
Add desktop documentation about building CLI wheel, and make CircleCI tests build CLI wheel first as well
Diffstat (limited to 'desktop')
-rw-r--r-- | desktop/README.md | 35 |
1 files changed, 19 insertions, 16 deletions
diff --git a/desktop/README.md b/desktop/README.md index b1b36956..cf3c4113 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -34,7 +34,15 @@ python scripts\get-tor-windows.py ### Prepare the code -#### All platforms +In order to work with the desktop app, you'll need to build a wheel of the CLI package first, and copy it into the `desktop` folder: + +```sh +cd ../cli +poetry install +poetry build +cp dist/onionshare_cli-*.whl ../desktop +cd ../desktop +``` OnionShare uses [Briefcase](https://briefcase.readthedocs.io/en/latest/). @@ -42,21 +50,16 @@ Install Briefcase dependencies by following [these instructions](https://docs.be Now create and/or activate a virtual environment. -#### Linux and macOS - -``` -python3 -m venv venv -. venv/bin/activate -``` - -#### Windows - -``` -python -m venv venv -venv\Scripts\activate.bat -``` - -#### All platforms +* Linux and macOS + ``` + python3 -m venv venv + . venv/bin/activate + ``` +* Windows + ``` + python -m venv venv + venv\Scripts\activate.bat + ``` While your virtual environment is active, install briefcase from pip. |