docs: clarify git loading situation

This commit is contained in:
hellerve 2019-05-01 00:24:29 +02:00
parent a49fc63f95
commit 122038fad3
2 changed files with 14 additions and 4 deletions

View File

@ -7,4 +7,4 @@
(register safe-sub (λ [Int Int (Ref Int)] Bool))
(doc safe-mul "Performs an multiplication and checks whether it overflowed.")
(register safe-mul (λ [Int Int (Ref Int)] Bool))
)
)

View File

@ -25,11 +25,21 @@ This line of configuration can be put into a `~/.carp/profile.carp` file to make
## Loading via git
You can also load libraries via git in this way:
You can also load libraries via Git like that:
`(load "https://github.com/hellerve/anima.carp@master")`
```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`.
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`.
Please note that currently only loading through SSH is supported. If you want to
make a library reading 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.
## Core Modules