From 04b24b009021147dcd1a72eb6947cf6c04e93d0f Mon Sep 17 00:00:00 2001 From: tcsenpai Date: Sun, 2 Mar 2025 22:31:43 +0100 Subject: [PATCH] better readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e751bd3..fd465d9 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ This project allows you to define your own programming language syntax by mappin - Direct execution of your language scripts - Interactive REPL for development - Compilation to Python bytecode +- VS Code extension for syntax highlighting - Extensive customization options ## Installation @@ -22,8 +23,16 @@ This project allows you to define your own programming language syntax by mappin 2. No additional dependencies required beyond Python 3.6+ +## Included Example + +The repository includes an example of a custom language called "rizzlang", complete with a VS Code extension. + +You can find the example in the `rizzlang` directory and the VS Code extension in the `rizzlang_ext` directory. + ## Quick Start +NOTE: You can skip 1 and 2 if you want to use the included example. Just replace the mapping file and script with the ones in the `rizzlang` directory. + 1. Create a default mapping file: ``` python transpiler.py create-mapping my_mapping.json