mirror of
https://github.com/carp-lang/Carp.git
synced 2024-09-17 16:38:14 +03:00
e9537a8ba9
* 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>
80 lines
3.6 KiB
Markdown
80 lines
3.6 KiB
Markdown
## Working with libraries and modules
|
|
|
|
Carp comes with a standard library called Core, sources are [here](../core/).
|
|
It consists of a number of modules.
|
|
Documentation is available [online](http://carp-lang.github.io/carp-docs/core/core_index.html) as well as [locally](./core/core_index.html) for most of them.
|
|
The majority of modules are loaded by default, see [Core.carp](../core/Core.carp) for details.
|
|
If your `CARP_DIR` environment variable is set up [properly](Install.md#setting-the-carp_dir), then the remaining libraries can easily be imported using the `load` command. For example, to get access to the Bench module, do the following:
|
|
|
|
```clojure
|
|
(load "Bench.carp")
|
|
```
|
|
|
|
Using the functions in the Bench module still requires pre-pending them with the module name, i.e. `(Bench.bench fib)`. To avoid that, also do `(use Bench)`.
|
|
|
|
To see what functions a certain module contains, use the `info` command:
|
|
|
|
```clojure
|
|
(info Bench)
|
|
```
|
|
|
|
External librares can be loaded by using their relative or absolute location in your file system as the path. To make a library publically available in a more general way you can add it to your Carp project's search path:s (found by running `:p` in the repl). For instance, here's how you would add the NCurses library so that it can be loaded with just `(load "NCurses.carp")`.
|
|
|
|
```clojure
|
|
(Project.config "search-path" "~/Projects/carp-ncurses")
|
|
```
|
|
|
|
This line of configuration can be put into [profile.carp](Manual.md#Profile-settings) to make it apply in all your projects.
|
|
|
|
## Loading via git
|
|
|
|
You can also load libraries via Git like that:
|
|
|
|
```clojure
|
|
(load "git@github.com:hellerve/anima.carp@master")
|
|
```
|
|
|
|
This will download the [Anima](https://github.com/hellerve/anima) library to
|
|
`~/.carp/libs/<library>/<tag>` and load the file `anima.carp` in it. To get a
|
|
stable version of the library you should specify a git tag rather than
|
|
`@master`.
|
|
|
|
If you want to make a library ready for loading, either prepare a file that has the same name
|
|
as the library—in the case above, `anima.carp`—or a file called `main.carp` as
|
|
an entrypoint.
|
|
|
|
Please note that for private repos only loading through SSH is supported. For public repos you can use HTTPS:
|
|
|
|
```clojure
|
|
(load "https://github.com/hellerve/anima@master")
|
|
```
|
|
|
|
## Documentation
|
|
|
|
You can generate HTML documentation for a set of modules by running `save-docs` in the REPL:
|
|
|
|
```clojure
|
|
> (save-docs Int Float String)
|
|
```
|
|
See the [ReadMe](./core/README.md) for updating the entire standard library documentation or
|
|
the [program](./core/generate_core_docs.carp) for examples of how to configure the documentation generator.
|
|
|
|
|
|
## Auto generated API documentation
|
|
|
|
* [online docu for Carp standard library](http://carp-lang.github.io/carp-docs/core/core_index.html)
|
|
* [local docu for Carp standard library](./core/core_index.html)
|
|
* [SDL](http://carp-lang.github.io/carp-docs/sdl/SDL_index.html)
|
|
|
|
## Some External Libraries
|
|
* [Anima](https://github.com/hellerve/anima) (A simple drawing and animation framework)
|
|
* [Stdint](https://github.com/hellerve/stdint) (A wrapper around the types defined in stdint.h)
|
|
* [Socket](https://github.com/hellerve/socket) (A wrapper around C sockets)
|
|
* [Physics](https://github.com/hellerve/physics) (A port of phys.js)
|
|
* [NCurses](https://github.com/eriksvedang/carp-ncurses) ([https://www.gnu.org/software/ncurses/](https://www.gnu.org/software/ncurses/))
|
|
* [Curl](https://github.com/eriksvedang/carp-curl) (Simple bindings to the Curl library)
|
|
|
|
For a growing list of Carp packages, see [Carpentry](https://github.com/carpentry-org).
|
|
|
|
Do you have a library that you want to plug here? Pleas make a PR!
|