Basic glossary

README.md

@@ -1,2 +1,34 @@
 # q-lang
 
+My best idea yet.  
+You can code only using the letter `q`.
+
+`qpilator` will take all your `q` code and convert it to a c file and compile it into an executable called `q.q`
+
+## Project structure
+
+The project is entirely made of `q` directories and files, each `q` file contain a number of `q` that determine instructions.  
+instruction are executed in order `q -> qq -> ..`
+
+## Glossary
+
+| symbol | interpretation |
+| ------ | -------------- |
+| `q`   | read registry |
+| `qq` | declare registry |
+| `qqq` | call function |
+| `qqqq` | declare function |
+| `qqqqq` | operator |
+
+### Type declaration
+
+when encountering thoose symbol `qpilator` will check a directory with the same name + `q` to find the value
+
+| symbol  | interpretation | range | method |
+| ------- | -------------- | ----- | ---- |
+| `q`  | bool | true - false | single file
+| `qq`  | uint | 0 .. 255 | single file
+| `qqq` | int | -127 .. 128 | single file
+| `qqqq` | string | [a-zA-Z] | one file per char*  |
+
+*qqqq -string : `empty = a, ..., 25q = z, 26q = A, ..., 51q = Z`