docs: show how to use the stdlib

leostera · Nov 1, 2020 · 27bc02d · 27bc02d
1 parent c1758b3
commit 27bc02d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git 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
@@ -1 +1 @@
-0.0.8
+0.0.14
diff --git 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
@@ -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"