aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 298feaf..969fea3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
FreeCAD module for creating boxes / cases suitable for laser cutting.
+
+# Development
+
+## Tips and tricks
+
+When developing this module make sure you have the *Python console* and *report views* visible. Enable them under View -> Panels if you don't have them visible.
+
+To reload the module when running:
+
+ # This is only needed once
+ import Boxer; import BoxerGui; import BoxerDockWidget
+
+ # Reloads all the modules
+ reload(Boxer); reload(BoxerGui); reload(BoxerDockWidget)
+
+## Possible new features
+
+**Make text labels indicating the box sides**:
+
+ import Draft
+ Draft.makeText(["Front"], point = FreeCAD.Vector(50.0,50.0,0.0))