diff --git a/README.md b/README.md index 626eb1c..20058e8 100644 --- a/README.md +++ b/README.md @@ -5,54 +5,14 @@ The CadQuery Module for FreeCAD ## Introduction -Module that adds a tabbed CadQuery editor to FreeCAD. Please see the [wiki](https://github.com/jmwright/cadquery-freecad-module/wiki) for more detailed information on getting started. +This is a FreeCAD module (aka workbench) that adds elements like a CadQuery code editor. All of the required libraries are embedded with the workbench, and so it is probably the fastest way to get up and running with CadQuery on a local computer. For users who just want to try CadQuery without installing anything, the [CadQuery Jupyter Notebook](https://mybinder.org/v2/gh/RustyVermeer/tryCQ/master) might be a better choice. ![User Interface](https://github.com/jmwright/cadquery-freecad-module/blob/master/docs/cqfm_user_interface.png) -## Install Through FreeCAD-Addons +The documentation for this module/workbench has been rewritten and restructured, and can be found [here](docs/index.md). Below are the main entry points into the documentation. - 1. Follow the instructions [here](https://github.com/FreeCAD/FreeCAD-addons/blob/master/README.md) to install and execute the FreeCAD-Addons macro. - 2. Choose `cadquery_module` from the list in the datalog box and click Install/Update. - 3. Restart FreeCAD. - -You can use the Install/Update button periodically to get the latest changes to this module. - -## Manual Installation -**Requires FreeCAD 0.14 or newer** - -Installation is handled slightly differently whether you are installing version 1.0.0.1 and earlier, or a later version. - -### Installing v1.0.0.1 and Earlier - -Download the [latest released version](https://github.com/jmwright/cadquery-freecad-module/releases), extract the archive file, and copy the `CadQuery` subdirectory to FreeCAD's `Mod` directory on your system. - -### Installing v1.0.0.2 and Later - -Download the [latest released version](https://github.com/jmwright/cadquery-freecad-module/releases), extract the archive file, and copy the entire extracted directory to FreeCAD's `Mod` directory on your system. You can optionally rename the directory to something like `CadQuery`. - -## Typical Installation Locations -The module should show up in the 'Workbenches' drop down the next time you start FreeCAD. Some typical `Mod` directory locations are as follows. - -### Linux -* /usr/lib/freecad/Mod -* /usr/local/lib/freecad/Mod -* ~/.FreeCAD/Mod - -If you are running Ubuntu Linux, be sure to run the following line in a terminal before using this module. -``` -sudo apt-get install python-pyside.qtnetwork -``` - -### Windows -* 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 -* /Applications/FreeCAD.app/Contents/Mod -* /Applications/FreeCAD.app/Mod -* /Users/[your_user_name]/Library/Preferences/FreeCAD/Mod -* ~/Library/Preferences/FreeCAD/Mod - -## It's Installed, Now What? -For getting started information and troubleshooting steps, please see the [wiki](https://github.com/jmwright/cadquery-freecad-module/wiki) +### Documentation +- [Introduction](docs/index.md#introduction) +- [Installation](docs/installation.md) +- [Usage](docs/usage.md) +- [Developers](docs/developers.md) diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..c419263 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 90e0363..089b8b1 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -44,11 +44,16 @@ Sometimes a different version or branch of the workbench may be needed, other th - ~/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. +You may get a `No module named QtNetwork` error on Ubuntu based systems when you select the module in FreeCAD. If you do, run the following command line from a terminal to fix this issue. ``` sudo apt-get install python-pyside.qtnetwork ``` +When running on Ubuntu 14.04 with the default version of FreeCAD included in the repositories, you may get a `No module named PySide` or `No module named QtGui` error. If you do, run the following line to install the missing packages. +``` +sudo apt-get install libboost-python1.54.0 libnglib-4.9.13 liboce-foundation10 liboce-modeling10 liboce-ocaf-lite10 liboce-ocaf10 liboce-visualization10 libpyside1.2 libshiboken1.2 python-pyside.qtcore python-pyside.qtgui python-pyside.qtsvg python-pyside.qtuitools python-pyside.qtxml +``` + ### Next Steps Once the workbench is installed, the next step is to read through the [usage instructions](usage.md).