mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2025-11-07 11:03:04 +00:00
Code Issues 1 Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Calvin Rose
2018-12-17 01:57:09 -05:00
parent 131ee29190
commit 003472354d
2 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -55,7 +55,12 @@ Documentation can be found in the doc directory of
the repository. There is an introduction
section contains a good overview of the language.
For individual bindings, use the `(doc symbol-name)` macro to get API
API documentation for all bindings can also be generated
with `make docs`, which will create `build/doc.html`, which
can be viewed with any web browser. This
includes all forms in the core library except special forms.
For individual bindings from within the REPL, use the `(doc symbol-name)` macro to get API
documentation for the core library. For example,
```
(doc doc)