readme updates

Signed-off-by: Ava Affine <ava@sunnypup.io>
This commit is contained in:
Ava Apples Affine 2024-07-12 21:59:18 -07:00
parent 74f73fb493
commit cdba0dfe89

View file

@ -283,7 +283,7 @@ Removing a symbol consists of a call to ~def~ with no additional arguments:
The following table is up to date as of Flesh 0.4.0. For latest information try the following: The following table is up to date as of Flesh 0.4.0. For latest information try the following:
- Call ~env~ from a fresh shell: ~(env)~ - Call ~env~ from a fresh shell: ~(env)~
This will output all variables and functions defined This will output all variables and functions defined
- Read the [[file:src/stl.rs][std library declaration code]]
| *Control Flow* | *Declaration* | *Shell* | *List* | *Math* | *Strings* | *Boolean* | *Userlib* | *Misc* | *Files* | | *Control Flow* | *Declaration* | *Shell* | *List* | *Math* | *Strings* | *Boolean* | *Userlib* | *Misc* | *Files* |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------+-------------| |----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------+-------------|
| if | lambda | pipe | car | float | strlen | toggle | reduce | call | read-file | | if | lambda | pipe | car | float | strlen | toggle | reduce | call | read-file |
@ -314,13 +314,14 @@ The following table is up to date as of Flesh 0.4.0. For latest information try
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------+-------------| |----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------+-------------|
| | | | | lte? | | | | | | | | | | | lte? | | | | | |
The Shell module and file module both are specific to the shell project and are not present in the core.
To learn how to use a given function use the ~help~ command. See the Documentation section for more information. To learn how to use a given function use the ~help~ command. See the Documentation section for more information.
* Documentation * Documentation
** Tests ** Tests
Most of the tests evaluate small scripts (single forms) and check their output. Most of the tests evaluate small scripts (single forms) and check their output.
Perusing them may yield answers on all the cases a given builtin can handle. Perusing them may yield answers on all the cases a given builtin can handle.
[[file:tests][The test directory]]
** Help function ** Help function
Flesh is self documenting. The *help* function can be used to inspect any variable or function. Flesh is self documenting. The *help* function can be used to inspect any variable or function.