diff --git a/README.md b/README.md index 6e19ab4..218651c 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,18 @@ CadQuery GUI editor based on PyQT supports Linux, Windows and Mac. ### Release Packages -Stable release builds which do not require Anaconda are attached to the [latest release](https://github.com/CadQuery/CQ-editor/releases). Download the zip file for your operating system, extract it, and run the CQ-editor script for your OS (CQ-editor.cmd for Windows, CQ-editor.sh for Linux and MacOS). On Windows you should be able to simply double-click on CQ-editor.cmd. On Linux and MacOS you may need to make the script executable with `chmod +x CQ-editor.sh` and run the script from the command line. The script contains an environment variable export that may be required to get CQ-editor to launch correctly on MacOS Big Sur, so it is better to use the script than to launch CQ-editor directly. +TBD ### Development Packages Development builds are also available, but can be unstable and should be used at your own risk. Click on the newest build with a green checkmark [here](https://github.com/jdegenstein/jmwright-CQ-editor/actions), wait for the _Artifacts_ section at the bottom of the page to load, and then click on the appropriate download for your operating system. Extract the archive file and run the shell (Linux/MacOS) or cmd (Windows) script in the root CQ-editor directory. The CQ-editor window should launch. -## Installation (Anaconda) -TBD +## Installation (pip) + +``` +pip install git+https://github.com/jdegenstein/jmwright-CQ-Editor +pip install --pre git+https://github.com/cadquery/cadquery +``` ## Usage