Update README.md

README.md

@@ -1,2 +1,28 @@
 # GcodeSplitter
 
+Split a Cura generated GCode file into several files.
+
+## Features
+
+* Split by layer number or layer Z position
+* Each individual GCode file will contain the header code for homing the printer and heating up the nozzle and bed
+
+## Requirements
+
+* Python 3.7
+* pipenv
+
+## Usage
+
+* Run `pipenv sync`
+* Edit the `__main__` part at the bottom of `GcodeFileSplitter.py`
+```python
+GcodeFileAnalyzer.SplitFileAtLayers(
+    'test/BigL.gcode',  # Relative or absolute path to gcode file
+    ['2.8mm', 300]  # Z heights where to split the file
+)
+```
+
+* The Z position where to split the file can be given in layer number (starting with 0) or in millimeters (value must match an actual layer z position in the gcode file)
+* Execute `GcodeFileSplitter.py`
+** E.g.: `pipenv run python GcodeFileSplitter.py`