diff --git a/docs/developers.md b/docs/developers.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/images/addon_manager_menu_item.png b/docs/images/addon_manager_menu_item.png new file mode 100644 index 0000000..3eb09b7 Binary files /dev/null and b/docs/images/addon_manager_menu_item.png differ diff --git a/docs/images/cadquery_module_addon_manager_item.png b/docs/images/cadquery_module_addon_manager_item.png new file mode 100644 index 0000000..503540c Binary files /dev/null and b/docs/images/cadquery_module_addon_manager_item.png differ diff --git a/docs/images/cadquery_workbench_item.png b/docs/images/cadquery_workbench_item.png new file mode 100644 index 0000000..5e96122 Binary files /dev/null and b/docs/images/cadquery_workbench_item.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..4ee1dc2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +## CadQuery Module for FreeCAD + +### Table of Contents +- [Installation](installation.md) +- [Usage](usage.md) +- [Developers](developers.md) + +### Introduction +This project adds a workbench to FreeCAD that makes it easy to get started using the [CadQuery API](http://dcowden.github.io/cadquery/). + +![User Interface](cqfm_user_interface.png) + +There are two philosophies that are probably the most influential in the design of this project. + +1. _"Batteries Included"_ - A user should not have to install a lot of requirements to get started. +2. _Flexibility_ - A user should be able to customize this workbench for their workflow. Being able to use an external code editor is an example. + +A stock code editor is included, along with examples showing everything from basic to advanced CadQuery scripting. This workbench also includes [cqparts](https://github.com/fragmuffin/cqparts), which is a library that adds support for parts and assemblies with constraints on top of CadQuery. + +Customizable settings are available, including settings that allow the use of an external code editor, if desired. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..f2efa68 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,47 @@ +## Installation + +### Automated +If you are running FreeCAD 0.17 or newer, which is recommended, this module is easy to install through the included addon manager. +1. Run the FreeCAD Addon Manager by clicking `Tools->Addon manager` +![Addon manager menu item](images/addon_manager_menu_item.png) +2. Scroll down and click on `cadquery_module` +![cadquery_module addon item](images/cadquery_module_addon_manager_item.png) +3. Click the `Install / update` button + +3. Restart FreeCAD + +4. Confirm that CadQuery is in the drop down menu of workbenches +![cadquery workbench item](images/cadquery_workbench_item.png) + +This process can be repeated to update the module every time changes are pushed to the master branch on GitHub. + +### Manual +Sometimes a different version or branch of the workbench may be needed, other than what is installed using the addon manager. The steps below outline +1. Download the [latest released version](https://github.com/jmwright/cadquery-freecad-module/releases) +2. Extract the archive file +3. Copy the entire extracted directory to FreeCAD's `Mod` directory on your system. Typical `Mod` directory locations are listed below. + +**Linux Mod Locations** +- /usr/lib/freecad/Mod +- /usr/local/lib/freecad/Mod +- ~/.FreeCAD/Mod + +**Windows Mod Locations** +- C:\Program Files\FreeCAD 0.14\Mod +- C:\Program Files (x86)\FreeCAD 0.14\Mod +- C:\Users\[your_user_name]\Application Data\FreeCAD\Mod + +**Mac Mod Locations** +- /Applications/FreeCAD.app/Contents/Mod +- /Applications/FreeCAD.app/Mod +- /Users/[your_user_name]/Library/Preferences/FreeCAD/Mod +- ~/Library/Preferences/FreeCAD/Mod + +### Troubleshooting +If you are running Ubuntu Linux, you may need to run the following line in a terminal before using this module. +``` +sudo apt-get install python-pyside.qtnetwork +``` + +### Next Steps +Once the workbench is installed, the next step is to read through the [usage instructions](usage.md). diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..e69de29