medeco updates and fixes and new gen file folder

.gitignore

@@ -1,2 +1,4 @@
-
-*.stl
+venv/
+web/__pycache__/
+web/serve.py.bak
+*.pyc

Makefile

@@ -13,7 +13,7 @@ endif
 
 SCAD_DIR = scad
 SVG_DIR = resources
-POLY_DIR = scad
+POLY_DIR = scad/gen
 JSON_DIR = build
 
 # Files to include
@@ -24,8 +24,11 @@ SCAD_SRC  = $(SCAD_DIR)/schlage_classic.scad \
             $(SCAD_DIR)/schlage_primus.scad \
             $(SCAD_DIR)/medeco_classic.scad \
             $(SCAD_DIR)/medeco_biaxial.scad \
+            $(SCAD_DIR)/medeco_M3.scad \
             $(SCAD_DIR)/master.scad \
             $(SCAD_DIR)/X103-KW12.scad \
+            $(SCAD_DIR)/falcon_025.scad \
+            $(SCAD_DIR)/lockwood.scad \
 
 # Generated polygon files
 POLY_OBJ = $(patsubst $(SVG_DIR)/%.svg,$(POLY_DIR)/%.gen.scad,$(SVG_SRC))

README.md

@@ -4,9 +4,61 @@ Tools for generating physical keys.
 ![Key in Inkscape](doc/inkscape.png "SC4")
 ![Key in OpenSCAD](doc/key.png "152698")
 
+# Installation
+Download the GitHub repository and extract the repository in the location you wish to use it.
+
+
+## Prerequisites
+
+Keygen requires OpenSCAD and Python to work properly. Both can be downloaded from their official websites.
+
+https://openscad.org/
+
+https://www.python.org/
+
+## Windows 
+Windows users will need to add OpenSCAD and python3 to the User Path; otherwise you will encounter errors. 
+
+OpenSCAD will install in "C:\Program Files\OpenSCAD" by default
+
+Add to Path:
+
+```
+C:\Program Files\OpenSCAD
+```
+
+## Linux
+Linux installation is more straightforward, see OpenSCAD Installation Guide 
+
+### Fedora 
+```
+sudo dnf install python3
+```
+
+```
+sudo dnf install openscad
+```
+
+
 ## How to use it
+The keygen.py file located in \keygen-master\bin will be your main method of interacting with keygen.
+
+Use the cd command to set your console's directory to keygen-master this will allow you to use the example commands as is.
+
+keygen-master is located in the download's folder.
+
+```
+cd Downloads\keygen-master\keygen-master
+```
+
+To enter the help menu shown below.
+
+```
+bin/keygen.py -h
+```
+
 ```
-usage: keygen.py [-h] [-b BITTING] [-u OUTLINE] [-w WARDING] [-o OUTPUT]
+usage: keygen.py [-h] [scad/SCADFILE] [-b BITTING] [-u OUTLINE] [-w WARDING] [-o OUTPUT]
                  filename
 
 Generates keys.
@@ -28,18 +80,24 @@ optional arguments:
 All remaining arguments are passed to OpenSCAD.
 ```
 
-### Examples
+It is important to use the appropriate scad file with the key you are trying to generate, see examples below scad/kwikset.scad or scad/schlage_classic.scad. Do not use the files that have a .gen. In them, they are used for generating the keys in OpenSCAD.
 
-```bin/keygen.py scad/kwikset.scad --bitting 25536 -o housekey.stl```
+If you do not get an output file, open the scad file you are trying to use and make sure you are using the correct variables as they are different across the key types some experimentation is required.
 
-```bin/keygen.py scad/schlage_classic.scad -u 6-pin -w L -b 999999 -o all_section_bump_key.stl```
+## Examples
 
-```bin/keygen.py scad/schlage_classic.scad -o key.png --render```
+```
+python bin/keygen.py scad/kwikset.scad --bitting 25536 -o housekey.stl
+```
 
-## Contributing
+```
+python bin/keygen.py scad/schlage_classic.scad -u 6-pin -w L -b 999999 -o all_section_bump_key.stl
+```
 
-There is a very limited selection of keys right now, to help out, see the guide on [how to model keys](doc/how_to_model_keys.md).
+```
+python bin/keygen.py scad/schlage_classic.scad -o key.png --render
+```
 
-## Music
+## Contributing
 
-There is no keygen music yet, in the meantime, try [here](https://soundcloud.com/dualtrax/sets/orion-keygen-music)
+There is a very limited selection of keys right now, to help out, see the guide on [how to model keys](doc/how_to_model_keys.md).