Skip to content

Commit

Permalink
Update README.md (#525)
Browse files Browse the repository at this point in the history
In the current manual there is no clear explanation on how to quickly get started to play around with CadQuery through the CQ-editor (binaries). 

Proposed change: 
Under "Getting started" start out with the thing most people running into this project for the first time will probably want to try first: just fiddle around with CQ-editor. In the CQ-editor "installation" section I'll propose a change to add binary installation instructions (which is much easier/quicker to get started with than "the Conda way").
  • Loading branch information
GeorgesPaul authored Dec 18, 2020
1 parent 82a043a commit adadea3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ The original version of CadQuery was built on the FreeCAD API. This was great be

## Getting started

To quickly play around with CadQuery and see it's capabilities, see the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor) manual.
If you want to use CadQuery for your own project, keep reading:

It is currently possible to use CadQuery for your own projects in 3 different ways:
* Using the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor)
* From a [Jupyter notebook](https://github.com/bernhard-42/jupyter-cadquery)
Expand Down

0 comments on commit adadea3

Please sign in to comment.