From 887875959aa84af92291db334898aaa20956e632 Mon Sep 17 00:00:00 2001
From: allexanderbergmans <allexander.bergmans@student.elisa.be>
Date: Fri, 3 Jul 2026 12:17:10 +0200
Subject: init

---
 editors/vscode/README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 editors/vscode/README.md

(limited to 'editors/vscode/README.md')

diff --git a/editors/vscode/README.md b/editors/vscode/README.md
new file mode 100644
index 0000000..e7db36d
--- /dev/null
+++ b/editors/vscode/README.md
@@ -0,0 +1,34 @@
+# ISA Syntax Highlighting for VS Code
+
+Highlights `.isa` definition files — block types, keys, hex values, comments, bit ranges, and booleans.
+
+## Install
+
+```bash
+# Symlink into your VS Code extensions folder
+mkdir -p ~/.vscode/extensions
+ln -sf "$PWD" ~/.vscode/extensions/myisa-isa-syntax
+```
+
+Or copy the folder:
+
+```bash
+cp -r "$PWD" ~/.vscode/extensions/myisa-isa-syntax
+```
+
+Then **reload VS Code** (`Cmd+Shift+P` → "Developer: Reload Window").
+
+Open any `.isa` file — syntax highlighting activates automatically.
+
+## Colors by token
+
+| Token | Color |
+|-------|-------|
+| `ARCH`, `FORMAT`, `REGISTER`, `INSTRUCTION`, `CSR` | Keyword purple |
+| Block name (e.g. `ADD`, `x0`, `R`) | Entity/type blue-green |
+| `END` | Keyword purple |
+| Keys (`NAME`, `OPCODE`, `DESC`, etc.) | Property orange/yellow |
+| `0x...` hex values | Numeric green |
+| `31:25` bit ranges | Numeric green |
+| `true`/`false` booleans | Language constant |
+| `#` comments | Comment gray |
-- 
cgit v1.3