From 50e2c9520ebd046248f7c4b8847514d035631986 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg?= <jeremyjove@gmail.com>
Date: Thu, 24 Jan 2019 11:42:01 +0000
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index edd5a57..4e4eb68 100644
--- a/README.md
+++ b/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`