affine/SHS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

squash! updated readme to improve documentation

Browse source
This commit is contained in:
Aidan 2021-05-23 21:06:18 -07:00
parent 87b11cff7a
commit 8d2811be87
No known key found for this signature in database
GPG key ID: 327711E983899316
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Readme.md
View file

@ -6,7 +6,8 @@ This shell was created to have extremely simple syntax. S-Expressions were chose
## Basic Syntax ## Basic Syntax
When in doubt the `print_ast` utility can be used to examine the output of the Lexing and Parsing process. Here you can spot any bugs regarding syntax. When in doubt the `print_ast` utility can be used to examine the output of the Lexing and Parsing process. Here you can spot any bugs regarding syntax.
`$ print_ast (example invocation`
`$ print_ast (example invocation)`
### Lists ### Lists
Any sequence of items within a set of parenthesis is a list. Any sequence of items within a set of parenthesis is a list.
@ -39,7 +40,7 @@ Function call: `(append () 1 2 3)`
System binary call: `(vim Readme.md)` System binary call: `(vim Readme.md)`
Control flow statement (enabled by function call): `(if (eq "example" (fread 'test_file')) (print "test worked) (rm -rf /))` Control flow statement: `(if (eq "example" (fread 'test_file')) (print "test worked) (rm -rf /))`
There may be alternative REPLs, officially or from community members, that do not exhibit this behavior. There may be alternative REPLs, officially or from community members, that do not exhibit this behavior.