diff --git a/README.md b/README.md new file mode 100644 index 0000000..92e5449 --- /dev/null +++ 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 diff --git a/documentation/specification.md b/documentation/specification.md index 079dc07..706eeb4 100644 --- a/documentation/specification.md +++ b/documentation/specification.md @@ -1,5 +1,5 @@ -# ?! specification -> The ?! utility converts so called the "C Style Markup Language" to HTML/XML and back. +# Cwheel specification +> 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. ## C Style Markup Language @@ -92,7 +92,7 @@ Note, that they are not requred to be always escaped, but are highly advised. #### Comments -CSML supports C99 (?!) style comments, +CSML supports C99 style comments, both single and multi line. That is: ```C @@ -109,24 +109,44 @@ This includes whitespace too. ## Translation -?! translates both ways in a single step, +CWheel translates both ways in a single step, from top to bottom, perserving formatting. Example: ``` - ?! + + +
+ + +