Documentation 1.1

Update readme.md

Update readme.md
This commit is contained in:
Kaiser 2021-12-16 12:33:15 +01:00
parent 5542468281
commit d1a3ff130f

View file

@ -6,46 +6,46 @@ Rust developers hate it, Python developers fear it, and C developers make it bli
## How to Strath ## How to Strath
### Comments ### Comments
; all text after a semicolon will be treated as a comment `;` all text after a semicolon will be treated as a comment
&& all text after a double and 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 `]][[` an inline command, all text between the double square brackets will be treated as a comment
`\`´´ this makes a multiline comment \`\`´´ this makes a multiline comment
### If, else if/elif, else ### If, else if/elif, else
¿??/condition\\? | () - if `¿??/condition\\? | ()` - if
?>/condition\\? | () - elif/else if `?>/condition\\? | ()` - elif/else if
\>?/condition\\? | () - else `\>?/condition\\? | ()` - else
After ?? and ?> either a $ or € to declare if all conditions are to be true or false respectivly 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 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 ### 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 Certain types have short declarations
ö declares ints `ö` declares ints
Ö declares floats `Ö` declares floats
ä declares char `ä` declares char
Ä declares string `Ä` declares string
ü declares list `ü` declares list
Ü declares dict `Ü` declares dict
wavey brackets aren't needed in this case wavey brackets aren't needed in this case
#### Working With Variables #### Working With Variables
Variables are declared by defining the type, the name, and the value (optional) eg: 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: Special behaviour:
j > i will copy i to j and drops i `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 maintain i
### In-build functions ### In-build functions
<= will output a value `<=` will output a value
=> takes an input and sets the next variable to it as the input `=>` takes an input and sets the next variable to it as the input
### Code ### Code
¡! are statments `¡!` are statments
¿? are expression `¿?` are expression