name the thing; better documentation

2023-11-14 00:03:35 +01:00
parent 7337f18a0e
commit 982479db6d
3 changed files with 42 additions and 8 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,14 @@
+# CWheel
+> The CWheel utility converts so called the "C Style Markup Language" to HTML/XML and back.
+> The primary aim is to maximize both editability and readability by dynamizing the markup representation.
+
+The CWheel utility itself is meant to serve as a backbone other tools,
+such as text editor or IDE extensions.
+
+For a complete explanation see documentation/specification.md.
+
+### Gallery
+
+### Installantion
+#### Vim
+#### Visual Studio Code