From 5437a003482a98c6b637e5331774885a83df88a6 Mon Sep 17 00:00:00 2001 From: sloumdrone Date: Sat, 20 Jul 2019 19:49:54 -0700 Subject: [PATCH] Further updates readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 01862c2..c5ac5e3 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ All elements in a filtress script are either a procedure, a variable, an opperat The following opperators are available: +, -, \*, /, %, =. If an opperator is not passed to a procedure before an opperand then = is assumed. As such, you never have to use =, just know that that is what filtress is doing in those cases. -All opperands can be passed as variables rather than as integers directly, with the exception of loops. Loops are started with the keyword (procedure) _BEG_ followed by a number, like so: _BEG 20_. Anything that comes on the following lines is a part of the loop until the keyword _END_. At present, due to the way loops are handled by the parser, this number cannot be filled in by a variable. Many procedures represent a data value and as such can also be used as a variable. For example: _RED +100_ increases the value of _RED_ by 100. If instead a person wanted to double red they could do _RED \*100_ or _RED +RED_. Multivalue procedures such as _COL_ and _LOC_ cannot be used as variables, nor can things that do not represent a specific value, such as _APY or BEG_. Similarly there are two values that cannot be used as procedures, only as variables: _WID_ and _HIG_. +All opperands can be passed as variables rather than as integers directly, with the exception of loops. Loops are started with the keyword (procedure) BEG followed by a number, like so: `BEG 20`. Anything that comes on the following lines is a part of the loop until the keyword _END_. At present, due to the way loops are handled by the parser, this number cannot be filled in by a variable. Many procedures represent a data value and as such can also be used as a variable. For example: `RED +100` increases the value of _RED_ by 100. If instead a person wanted to double red they could do `RED *10` or `RED +RED`. Multivalue procedures such as _COL_ and _LOC_ cannot be used as variables, nor can things that do not represent a specific value, such as _APY or BEG_. Similarly there are two values that cannot be used as procedures, only as variables: _WID_ and _HIG_. Aside from the above, there are a few things to know. Comments are begun with the _#_ symbol and go until end of line. These will be ignored by the parser. Each statement, consisting of a procedure and, optionally in some cases, an expression and or comment, must be on its own line. -For a more detailed overview of each prcedure and variable please visit the [filtress manual](http://rawtext.club/~sloum). Another good resource to check out is the examplei\_filters folder of this repo. +For a more detailed overview of each prcedure and variable please visit the [filtress manual](http://rawtext.club/~sloum). Another good resource to check out is the example\_filters folder of this repo. ## Intallation, Building, Dependencies Building filtress from source requires the Go compiler. No dependencies beyond the go standard library are required.