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

add a function table to the readme

Browse source
This commit is contained in:
Ava Apples Affine 2023-05-26 00:05:59 -07:00
parent e31090744a
commit 6ab075c2bb
1 changed files with 32 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

34
Readme.org
View file

@ -266,10 +266,41 @@ Removing a symbol consists of a call to ~def~ with no additional arguments:
#+END_SRC
** Builtin functions
As opposed to listing every builtin function here, it is suggested to the user to do one of two things:
The following table is up to date as of Relish 0.3.0. For latest information try the following:
- Call ~env~ from a fresh shell: ~(env)~
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* |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| if | lambda | pipe | car | float | strlen | toggle | reduce | call |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| let | q / quote | load-to-string | len | sub | substr? | bool | prepend | help |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| circuit | def | load / l | cons | mul | echo | and | add-path | env |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| while | get-doc | load-with | cdr | inc | split | eq? | set | eval |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | set-doc | cd | reverse | dec | input | not | map | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | set? | fg | dq | div | concat | or | get-paths | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | pop | gte? | string | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | int | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | mod | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | exp | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | lt? | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | gt? | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | add | | | | |
|----------------+---------------+----------------+---------+--------+-----------+-----------+-----------+--------|
| | | | | lte? | | | | |
To learn how to use a given function use the ~help~ command. See the Documentation section for more information.
** Documentation
*** Tests
@ -489,7 +520,6 @@ Note: this section will not show the status of each item unless you are viewing
Note: this section only tracks the state of incomplete TODO items. Having everything on here would be cluttered.
** TODO v1.0 tasks
- Readme has table of stdlib functions
- Create an introductory presentation
- put a ko-fi in the readme or something
- Post to relevant channels