From 27bc02d4c865d73764d3aadb2c77f0e815460e44 Mon Sep 17 00:00:00 2001 From: Leandro Ostera Date: Sun, 1 Nov 2020 21:55:52 +0100 Subject: [PATCH] docs: show how to use the stdlib --- README.md | 13 +++++++++++++ VERSION | 2 +- dune-project | 1 + erlang.opam | 3 ++- 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f54f537cd..70b5e7d95d 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,19 @@ Eshell V11.0.3 (abort with ^G) <<"world">> ``` +To make use of the entire standard library you'll have to run `erlc` to compile it: + +```sh +# after unzipping +$ erlc ./caramel/lib/caramel/stdlib/beam/*.erl +$ erl -pa ./caramel/lib/stdlib/beam +Erlang/OTP 23 [erts-11.0.3] [source] [64-bit] [smp:64:64] [ds:64:64:10] [async-threads:1] [hipe] + +Eshell V11.0.3 (abort with ^G) +1> caramel_runtime:binary_concat(<<"hello, ">>, <<"world!">>). +<<"hello, world!">> +``` + ## Examples You can find several examples in [`./examples`](./examples), and in diff --git a/VERSION b/VERSION index d169b2f2d0..9789c4ccb0 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.0.8 +0.0.14 diff --git a/dune-project b/dune-project index a3d7363aa6..4bd1b71bf0 100644 --- a/dune-project +++ b/dune-project @@ -24,6 +24,7 @@ (depends (dune (>= "2.7")) (ocaml (>= "4.11.1")) + cmdliner menhir ppx_sexp_conv sexplib diff --git a/erlang.opam b/erlang.opam index 7aae010db2..503c89be3d 100644 --- a/erlang.opam +++ b/erlang.opam @@ -14,8 +14,9 @@ license: "Apache-2.0" homepage: "https://github.com/AbstractMachinesLab/caramel" bug-reports: "https://github.com/AbstractMachinesLab/caramel/issues" depends: [ - "dune" {>= "2.7" & >= "2.7"} + "dune" {>= "2.7" } "ocaml" {>= "4.11.1"} + "cmdliner" "menhir" "ppx_sexp_conv" "sexplib"