From b1ae816011efd1e09ed738f9251696cf369ba711 Mon Sep 17 00:00:00 2001
From: TenTech <45683060+TengerTechnologies@users.noreply.github.com>
Date: Thu, 23 Jan 2025 22:46:27 +0100
Subject: [PATCH] Create README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f006d68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+This is a script to add Brick layers to Prusaslicer and Orcaslicer.
+(As of now it doesn't work with Bambu printers)
+
+To use it you need to have Python installed. (www.python.org) 
+
+In Prusaslicer's printsettings go to "Output options". There you will find a section called "Post processing scripts". 
+You can add the following to run the script:
+
+```"C:\Your\Path\To\Python\python.exe" "C:\Your\Path\To\Script\bricklayers.py"```
+
+This will run it with a default layerheight of 0.2.
+
+There are two parameters you can add. -layerHeight and -extrusionMultiplier
+
+The layerheight has to match the settings in the slicer to work as intended,
+The extrusionmultiplier multiplies the extrusions of the shifted layers so you can use it to probably increase strenght(has yet to be tested).
+
+Sample: 
+
+```"C:\Your\Path\To\Python\python.exe" "C:\Your\Path\To\Script\bricklayers.py" -layerheight 0.2 -extrusionMultiplier 1.3```
+
+Thanks to all of you who opened issues and made pullrequests. I'm not ignoring you, I just didn't have the time to review yet. I will do on the weekend!<3
+(I will also make a good readme then)
+
+Here is a video about the script.
+
+[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/EqRdQOoK5hc/0.jpg)](https://www.youtube.com/watch?v=EqRdQOoK5hc)