suzanne.soy/cadquery-freecad-module
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mdoifed docs to point to cadquery-freecad-module

Browse Source
This commit is contained in:
Dave Cowden 2014-12-06 09:23:04 -05:00
parent d9ca06a6e8
commit a040b0c35e
2 changed files with 44 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -12,9 +12,21 @@ CadQuery has several goals:
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. 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.
Getting Started With CadQuery
========================================
The easiest way to get started with CadQuery is to Install FreeCAD ( version 14 recommended ) (http://www.freecadweb.org/) , and then to use Jeremy's Great CadQuery-FreeCAD plugin here:
https://github.com/jmwright/cadquery-freecad-module
It has super-easy installation on Mac, Windows, and Unix, and features code-autocompletion and a bunch of examples that will run right in FreeCAD.
Recently Added Features Recently Added Features
======================================== ========================================
* 12/5/14 -- New FreeCAD/CadQuery Module! https://github.com/jmwright/cadquery-freecad-module
* 10/25/14 -- Added Revolution Feature ( thanks Jeremy ! ) * 10/25/14 -- Added Revolution Feature ( thanks Jeremy ! )
@ -50,11 +62,9 @@ CadQuery is licensed under the terms of the LGPLv3. http://www.gnu.org/copyleft/
Where is the GUI? Where is the GUI?
================== ==================
CadQuery does not provide a stand-alone gui yet, though this is one of the projects we hope to tackle. If you would like IDE support, you can use CadQuery inside of FreeCAD. There's an excellent plugin module here https://github.com/jmwright/cadquery-freecad-module
If you would like IDE support, you can use CadQuery inside of FreeCAD. CadQuery also provides the backbone of http://parametricparts.com, so the easiest way to see it in action is to review the samples and objects there.
CadQuery provides the backbone of http://parametricparts.com, so the easiest way to see it in action is to review the samples and objects there.
Installing -- FreeStanding Installation Installing -- FreeStanding Installation
======================================== ========================================
@ -92,25 +102,8 @@ You're up and running!
Installing -- Using CadQuery from Inside FreeCAD Installing -- Using CadQuery from Inside FreeCAD
================================================= =================================================
Use these steps if you would like to write CadQuery scripts from inside of the FreeCAD IDE. These steps have only been tested on windows <Thanks Tim Henderson!> Use the Excellent CadQuery-FreeCAD plugin here:
https://github.com/jmwright/cadquery-freecad-module
1. install FreeCAD, version 0.12 or greater for your platform. http://sourceforge.net/projects/free-cad/.
2. Copy the entire CadQuery distribution into the FreeCAD/bin dir
3. use the Python version embedded with Freecad to set up cadquery, eg:
cd "C:\Program Files\FreeCAD0.13\bin"
python "C:\Program Files\FreeCAD0.13\bin\cadquery-0.1.4/setup.py install
4. copy generated binaries from FreeCAD0.13/bin/cadquery/cadquery into FreeCAD/Mod/Scripts
Thats it. Now when you start FreeCAD, you can do for example:
import cadquery
bb = cadquery.Workplane("XY").box(1.0,2.0,3.0) //bb is a cadquery object
solid = bb.val() //solid is a cadquery solid object
Part.show(solid.wrapped) //use the wrapped property of a cadquery primitive to get the FreeCAD version
Where does the name CadQuery come from? Where does the name CadQuery come from?

32
README.txt
View File

@ -12,6 +12,24 @@ CadQuery has several goals:
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. 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.
Getting Started With CadQuery
========================================
The easiest way to get started with CadQuery is to Install FreeCAD ( version 14 recommended ) (http://www.freecadweb.org/) , and then to use Jeremy's Great CadQuery-FreeCAD plugin here:
https://github.com/jmwright/cadquery-freecad-module
It has super-easy installation on Mac, Windows, and Unix, and features code-autocompletion and a bunch of examples that will run right in FreeCAD.
Recently Added Features
========================================
* 12/5/14 -- New FreeCAD/CadQuery Module! https://github.com/jmwright/cadquery-freecad-module
* 10/25/14 -- Added Revolution Feature ( thanks Jeremy ! )
Why CadQuery instead of OpenSCAD? Why CadQuery instead of OpenSCAD?
======================================== ========================================
@ -44,12 +62,14 @@ CadQuery is licensed under the terms of the LGPLv3. http://www.gnu.org/copyleft/
Where is the GUI? Where is the GUI?
================== ==================
CadQuery does not provide a stand-alone gui yet, though this is one of the projects we hope to tackle. If you would like IDE support, you can use CadQuery inside of FreeCAD. There's an excellent plugin module here https://github.com/jmwright/cadquery-freecad-module
CadQuery provides the backbone of http://parametricparts.com, so the easiest way to see it in action is to review the samples and objects there. CadQuery also provides the backbone of http://parametricparts.com, so the easiest way to see it in action is to review the samples and objects there.
Installing Installing -- FreeStanding Installation
============ ========================================
Use these steps if you would like to write CadQuery scripts as a python API. In this case, FreeCAD is used only as a CAD kernel.
1. install FreeCAD, version 0.12 or greater for your platform. http://sourceforge.net/projects/free-cad/. 1. install FreeCAD, version 0.12 or greater for your platform. http://sourceforge.net/projects/free-cad/.
@ -79,7 +99,11 @@ Installing
You're up and running! You're up and running!
Installing -- Using CadQuery from Inside FreeCAD
=================================================
Use the Excellent CadQuery-FreeCAD plugin here:
https://github.com/jmwright/cadquery-freecad-module
Where does the name CadQuery come from? Where does the name CadQuery come from?