From cad7bc94be88c8d84d3c41c176d23ec19c451ffa Mon Sep 17 00:00:00 2001 From: Matthew Date: Wed, 4 Feb 2026 07:06:19 +1100 Subject: [PATCH] update readme --- readme.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 4997e50..d2d7728 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,13 @@ # ScratchPad -A text editor I'm developing for personal use as well as getting used to 2D and UI development with Vulkan. +A text editor I'm developing for personal use as well as getting used to 2D and UI development with Vulkan. It currently only supports Linux due to being built for X11 and x86_64 due to inline assembler usage but will eventually be corrected. + +Building requires ldc2/dub/vulkan SDK/glslc/freetype to be installed, running the command will build it and place it in the build folder + +``` +dub build main:editor +``` + +Inputs are Inputs are ```i``` to go into insert mode (a la vim) and ```:``` to open the command palette with typing to search, ```up``` and ```down``` to navigate and ```enter``` to select an option and clicking on a panel to focus it. It's currently in an early state, it has core functionality built out but is still a work in progress and isn't currently recommended for use.