From adadea3780c98675b4bb0f9e063fbb8ebde5f722 Mon Sep 17 00:00:00 2001 From: GeorgesPaul Date: Fri, 18 Dec 2020 08:43:31 +0100 Subject: [PATCH] Update README.md (#525) 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"). --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index dcba79820..30529ab1b 100644 --- a/README.md +++ b/README.md @@ -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)