From 7c0fe5239ce897a1f466ee72e3ccf4b1a6723413 Mon Sep 17 00:00:00 2001 From: 0x23 Date: Sat, 18 Oct 2025 15:06:23 +0200 Subject: [PATCH] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index fa5bd34..ad0e1f7 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,15 @@ A 'magnetic gearing' approach increases the resolution of the low-cost magnetic The device can be controlled via simple G-Code commands over a USB serial interface and is thus easily integrated into other projects. The firmware implements a complete motion planning stack with look-ahead for smooth and accurate path following capabilities. +## Getting Started + +Below is a list of high level steps you can follow if you want to replicate the project. If you have questions or problems with the build, joint the discord server to get help. + +1. Read this Document and whatch the linked videos +2. Get the parts listed in [Bill of Materials](documentation/bom/bom.md) +3. Build the device and electronics +4. Upload firmware using VSCode with PlattformIO plugin +5. Calibrate axis ## 💬 Discord Server