aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2016-06-15 00:08:05 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2016-06-15 00:08:05 +0200
commitf5b028e4665e27235b03048826a2a44f6017d4bd (patch)
treec24b95e1020e07301c18f595e0f08ba772cd69b0
parent32139455bfc7cbd3e6886ca195136b7b80a15d74 (diff)
downloadfreecad-boxer-f5b028e4665e27235b03048826a2a44f6017d4bd.tar.gz
freecad-boxer-f5b028e4665e27235b03048826a2a44f6017d4bd.tar.bz2
freecad-boxer-f5b028e4665e27235b03048826a2a44f6017d4bd.tar.xz
freecad-boxer-f5b028e4665e27235b03048826a2a44f6017d4bd.zip
o Adding some installation instructions.
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5fe8626..07a0af4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,17 @@
FreeCAD module for creating boxes / cases suitable for laser cutting.
+# Installation
+
+Create the installation directory:
+
+ mkdir -p ~/.FreeCAD/Mod
+
+Either unzip the downloaded zip file or git clone the repository:
+
+ cd ~/.FreeCAD/Mod
+ unzip ../freecad-boxer.zip # or
+ git clone https://trygvis.io/git/2016/05/freecad-boxer.git
+
# Development
## Tips and tricks