From eb8db0cb1b412d63ff753c8bb6d396581716e520 Mon Sep 17 00:00:00 2001
From: eworc778 <noreply@localhost>
Date: Mon, 25 Aug 2025 21:49:29 +0100
Subject: [PATCH] Updated README.MD to point to new syntax documentation.

---
 README.MD |  2 +-
 SYNTAX.MD | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+), 1 deletion(-)
 create mode 100644 SYNTAX.MD

diff --git a/README.MD b/README.MD
index 63c76c1..c764073 100644
--- a/README.MD
+++ b/README.MD
@@ -5,7 +5,7 @@ Kico is an open source macro pad, powered by RP2040.
 
 This repository inicludes the code for the RP2040, pinouts, and example macro files.
 
-Syntax for the macro engine is visible in `code.py`.
+Syntax for the macro engine is visible in [SYNTAX.MD](SYNTAX.MD).
 
 > This project is licensed under the MIT license. For more information see `LICENSE`.
 
diff --git a/SYNTAX.MD b/SYNTAX.MD
new file mode 100644
index 0000000..9e01a22
--- /dev/null
+++ b/SYNTAX.MD
@@ -0,0 +1,58 @@
+Kico macro file syntax:
+
+> Macro files must be placed in the 'macros' folder in the pico's internal storage.
+> Macro files must be saved as '.mcr' files.
+
+The Kico is capable of typing most characters.
+
+Each line in the file is read as a single instruction.
+
+- "\<string>": Types out the string inside the quotes. Allows most characters, exluding '\\' and '/'
+
+- #: Used at the start of a line to mark a it as a comment. Comments are not executed, but are still displayed.
+
+- LCD_SHOW "\<string>": Displays a string on the top line of the LCD.
+
+- WAIT \<duration>: Pauses execution for the specified interval. Accepts either an integer or a float.
+
+- HOLD: Starts reading up to 6 of the next keys as a combination.
+
+- RELEASE: Releases a held combination of up to 6 keys.
+
+## Key aliases:
+
+> Aliases must be entered on their own line, without quotes.
+
+- super: Key commonly marked as with a Windows Icon on most keyboards.
+
+- windows: Key commonly marked as Windows Icon on most keyboards.
+ 
+- enter: Enter key, sometimes marked as return. Mainly used for newlines.
+ 
+- escape: Key commonly marked as "Esc" on most keyboards.
+ 
+- tab: A tab character.f<1-24>: Function keys one through 24.
+ 
+- ctrl: Left control key.
+ 
+- shift: Left shift key. Can be used in hold combinations to capitalise a specific key.
+ 
+- downarrow: Down arrow key.
+ 
+- uparrow: Up arrow key.
+ 
+- leftarrow: Left arrow key.
+ 
+- rightarrow: Right arrow key.
+ 
+- space: A space character (" ").
+ 
+- capslock: Caps lock key, is toggled when sent.
+ 
+- delete: Delete key.
+ 
+- forwardslash: A "/" character.
+ 
+- backslash: A "\\" character.
+ 
+- backspace: The backspace key.
\ No newline at end of file