Skip to content

Commit 083e5da

Browse files
authored
Merge pull request #1129 from jpoles1/master
Revamping Cheatsheet
2 parents 25290e8 + b964226 commit 083e5da

File tree

3 files changed

+667
-404
lines changed

3 files changed

+667
-404
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4498634.svg)](https://doi.org/10.5281/zenodo.4498634)
99

1010

11+
---
12+
13+
### Quick Links
14+
[***Documentation***](https://cadquery.readthedocs.io/en/latest/) | [***Cheatsheet***](https://cadquery.readthedocs.io/en/latest/_static/cadquery_cheatsheet.html) | [***Discord***](https://discord.com/invite/Bj9AQPsCfx) | [***Google Group***](https://groups.google.com/g/cadquery) | [***GUI Editor***](https://github.com/CadQuery/CQ-editor)
15+
16+
---
17+
1118
## What is CadQuery
1219

1320
CadQuery is an intuitive, easy-to-use Python module for building parametric 3D CAD models. Using CadQuery, you can write short, simple scripts that produce high quality CAD models. It is easy to make many different objects using a single script that can be customized.
@@ -34,16 +41,19 @@ The original version of CadQuery was built on the FreeCAD API. This was great be
3441

3542
## Getting started
3643

37-
To quickly play around with CadQuery and see it's capabilities, see the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor) manual.
38-
If you want to use CadQuery for your own project, keep reading:
44+
To learn more about designing with CadQuery, visit the [documentation](https://cadquery.readthedocs.io/en/latest/intro.html), [examples](https://cadquery.readthedocs.io/en/latest/examples.html), and [cheatsheet](https://cadquery.readthedocs.io/en/latest/_static/cadquery_cheatsheet.html).
3945

40-
It is currently possible to use CadQuery for your own projects in 3 different ways:
46+
To get started playing around with CadQuery and see it's capabilities, take a look at the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor). This easy-to-use IDE is a great way to get started desiging with CadQuery.
47+
48+
There are currently 4 different ways to use CadQuery for designing your next project:
4149
* Using the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor)
4250
* From a [Jupyter notebook](https://github.com/bernhard-42/jupyter-cadquery)
51+
* Using a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=roipoussiere.cadquery)
4352
* As a standalone library
4453
* Linux [installation video](https://youtu.be/sjLTePOq8bQ)
4554
* Windows [installation video](https://youtu.be/3Tg_RJhqZRg)
4655

56+
4757
There are two ways to install CadQuery and its dependencies. One is using conda, and the other is using pip. Pip is shown first below, followed by two sections on installing CadQuery via conda, and a non-intrusive way to install conda on a system. Note that conda is the better supported option.
4858

4959
### CadQuery Installation Via Pip

0 commit comments

Comments
 (0)