diff --git a/README.md b/README.md index 021da92..25fc2fc 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,8 @@ Specifically: ### Other Dependencies +* git +* git-lfs * @microelly2's fork of PyFlow: https://github.com/microelly2/PyFlow * The original PyFlow repo is at https://github.com/wonderworks-software/PyFlow * [Qt.py](https://github.com/mottosso/Qt.py) a 'minimal Python 2 & 3 shim around all Qt bindings - PySide, PySide2, PyQt4 and PyQt5' @@ -89,9 +91,15 @@ git clone https://github.com/microelly2/NodeEditor ## Usage **Important Note**: Addon is still heavily developed and is shown here as a proof-of-concept for the time being. -1. Start FreeCAD +1. Start FreeCAD 2. Select PyFlow workbench from the workbench dropdown list -3. In the FreeCAD python console test the installation of the required modules +3. Set the package location +* in the "tools" menu (note the lower case spelling) +* "display Preferences window" +* Set "Additional package locations" to "/home/$you/.FreeCAD/Mod/NodeEditor/PyFlowPackages" +* where $you is for your homedir, cf: `cd ~; pwd`) +![additional package locations](https://forum.freecadweb.org/download/file.php?id=101187) +4. In the FreeCAD python console test the installation of the required modules ```python import Qt >>> Qt @@ -109,9 +117,9 @@ print(numpy) # import nodeeditor ``` -4. Open the PyFlow Workbench -5. run the Script "create all Nodes for Test" from Menu tests -6. run the Script "run Test for All Nodes" from Menu tests +5. Open the PyFlow Workbench +6. run the Script "create all Nodes for Test" from Menu tests +7. run the Script "run Test for All Nodes" from Menu tests ## Documentation