mirrors
/
janet
mirror of https://github.com/janet-lang/janet
1
0
Fork 0
Code Issues 1 Releases Wiki Activity

Update README.md

This commit is contained in:
Calvin Rose 2018-11-16 22:36:47 -05:00
parent fcbd24cedc
commit 0ff9ac2fb9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -50,6 +50,16 @@ API documentation and design documents can be found in the
[wiki](https://github.com/bakpakin/janet/wiki). There is an introduction
section in the wiki that contains a good overview of the language.
For individual bindings, use the `(doc symbol-name)` macro to get API
documentation for the core library. For example,
```
(doc doc)
```
Shows documentation for the doc macro.
To get a list of all bindings in the default
environment, use the `(all-symbols)` function.
## Usage
A repl is launched when the binary is invoked with no arguments. Pass the -h flag