summaryrefslogtreecommitdiff
path: root/crates/windlass/README.md
diff options
context:
space:
mode:
authortcmal <me@aria.rip>2024-09-12 16:33:19 +0100
committertcmal <me@aria.rip>2024-09-17 16:12:30 +0100
commit5f9fbea5a1b08962887d16457e77a922919a8818 (patch)
treee326db0d8b56f41d4f62ffaf909311363c59cae4 /crates/windlass/README.md
parent9a7042df7f9a7ad0324c4442ae918c2a4a442966 (diff)
Vendor windlass (control-side klipper protocol implementation)
Diffstat (limited to 'crates/windlass/README.md')
-rw-r--r--crates/windlass/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/crates/windlass/README.md b/crates/windlass/README.md
new file mode 100644
index 0000000..5d35c7d
--- /dev/null
+++ b/crates/windlass/README.md
@@ -0,0 +1,18 @@
+# Windlass
+
+This code was originally sourced from [https://github.com/Annex-Engineering/windlass/tree/master](annex-engineering).
+
+Windlass is an implementation of the host side of the Klipper protocol.
+
+## Licensing
+
+Windlass is licensed under the MIT license, which means you can do pretty much
+whatever you want with it. Please see [LICENSE.txt](LICENSE.txt) for more
+information.
+
+## Acknowledgements
+
+This project is in no way endorsed by the Klipper project. Please do not direct
+any support requests to the Klipper project.
+
+ * [Klipper](https://www.klipper3d.org/) by [Kevin O'Connor](https://www.patreon.com/koconnor)