Carp/docs/core/README.md
guberathome e9537a8ba9
PR: additional local documentation as html (#1229)
* docs: implemented python script to convert local documentation from .md files to .html files

* docs: filled index.md; reviewed all references in .md files

* docs: updated Embedded.md and resized carp_on_arduboy.jpg to sensible width

* docs: copy sub folders (./docs/core and ./docs/sdl) to ./docs-html/ and refer docu to it

* docs: phrased requirements more clearly

* docs: generate docs for Standard libraries before converting .md docs to .html

* docs: change index to markdown lists

* docs: index.md worked around limitation in md converter

* docs: removed modules count from Libraries.md

Co-authored-by: guberatsie <gunnar.bernhardt@siemens.com>
2021-05-31 10:15:09 +02:00

451 B

The Carp Standard Library Reference can be found online but your Carp installation should also contain a local copy in this very directory.

You can call a short Carp program to refresh the local copy. Please note that the program expects to be run from the Carp installation directory not from ./docs/core:

carp -x ./docs/core/generate_core_docs.carp