From d1a3ff130f61cf25c24f676f7d950f14ae1cdcdb Mon Sep 17 00:00:00 2001 From: Kaiser <54066349+Ihre-Kaiserliche-Hoheit@users.noreply.github.com> Date: Thu, 16 Dec 2021 12:33:15 +0100 Subject: [PATCH] Documentation 1.1 Update readme.md Update readme.md --- readme.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/readme.md b/readme.md index 3bf2514..a48038c 100644 --- a/readme.md +++ b/readme.md @@ -6,46 +6,46 @@ Rust developers hate it, Python developers fear it, and C developers make it bli ## How to Strath ### Comments -; all text after a semicolon will be treated as a comment -&& all text after a double and will be treated as a comment -]][[ an inline command, all text between the double square brackets will be treated as a comment -`\`´´ this makes a multiline comment +`;` all text after a semicolon will be treated as a comment +`&&` all text after a double and will be treated as a comment +`]][[` an inline command, all text between the double square brackets will be treated as a comment +\`\`´´ this makes a multiline comment ### If, else if/elif, else -¿??/condition\\? | () - if -?>/condition\\? | () - elif/else if -\>?/condition\\? | () - else +`¿??/condition\\? | ()` - if +`?>/condition\\? | ()` - elif/else if +`\>?/condition\\? | ()` - else -After ?? and ?> either a $ or € to declare if all conditions are to be true or false respectivly -Two variables will be compared by an if statment without "==" eg ¿??$/1 1\\? | () compares if 1 == 1 and if that result needs to be true to run the code in between the two round brackets +After `??` and `?>` either a `$` or `€` to declare if all conditions are to be true or false respectivly +Two variables will be compared by an if statment without "==" eg `¿??$/1 1\\? | ()` compares if 1 == 1 and if that result needs to be true to run the code in between the two round brackets ### Variable Types -}}type{{ uses the standard types like int, str, float, etc +`}}type{{` uses the standard types like int, str, float, etc Certain types have short declarations -ö declares ints -Ö declares floats -ä declares char -Ä declares string -ü declares list -Ü declares dict +`ö` declares ints +`Ö` declares floats +`ä` declares char +`Ä` declares string +`ü` declares list +`Ü` declares dict wavey brackets aren't needed in this case #### Working With Variables Variables are declared by defining the type, the name, and the value (optional) eg: -}}int{{ i < 1; +`}}int{{ i < 1;` -}int{ i < 1; A single wavy bracket allows the type of the var to change dynamicly +`}int{ i < 1;` A single wavy bracket allows the type of the var to change dynamicly Special behaviour: -j > i will copy i to j and drops i -j < i will copy i to j and maintain i +`j > i` will copy i to j and drops i +`j < i` will copy i to j and maintain i ### In-build functions -<= will output a value -=> takes an input and sets the next variable to it as the input +`<=` will output a value +`=>` takes an input and sets the next variable to it as the input ### Code -¡! are statments -¿? are expression +`¡!` are statments +`¿?` are expression