mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md install to match readthedocs/install more closely

Browse source
This commit is contained in:
jdegenstein 2023-10-23 09:40:06 -05:00 • committed by GitHub
parent 63dc6c5941
commit 79f77ffd6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -13,13 +13,26 @@ The documentation for **build123d** can found at [readthedocs](https://build123d
There is a [***Discord***](https://discord.com/invite/Bj9AQPsCfx) server (shared with CadQuery) where you can ask for help in the build123d channel.
To install **build123d** from github:
The recommended method for most users is to install **build123d** with one of the following two commands.
In Linux/MacOS, use the following command:
```
python3 -m pip install git+https://github.com/gumyr/build123d
```
In Windows, use the following command:
```
python -m pip install git+https://github.com/gumyr/build123d
```
If you receive errors about conflicting dependencies, you can retry the installation after having upgraded pip to the latest version with the following command:
```
python3 -m pip install --upgrade pip
```
Development install
```
git clone https://github.com/gumyr/build123d.git
cd build123d
python3 -m pip install -e .
```
Further installation instructions are available (e.g. Poetry, Apple Silicon) [installation on readthedocs](https://build123d.readthedocs.io/en/latest/installation.html).