jozanza / ocaml-rust-starter

Getting started with ocaml-rs

ocaml-rust-starter

An example project using ocaml-rs.

New project checklist

• Update README.md
• Update the project name in dune-project
• Update the crate name in Cargo.toml
• Update src/dune and test/dune with the name of your project in place of ocaml_rust_example/ocaml-rust-example
• Rename ocaml-rust-starter.opam to match the name of your project
• Remove src/ocaml_rust_example.ml and src/ocaml_rust_example.mli and add your own OCaml files
• Edit src/lib.rs
• Add your tests to test/test.ml
• Use cargo vendor if you intend to make the project installable using opam

Many of the renaming steps can be automated using init.sh:

$ ./init.sh my_project my-project

init.sh accepts two arguments: the name of the OCaml project and the public_name, if they are the same then one argument is acceptable.

NOTE: init.sh is destructive and can only be executed once (it will remove itself) - make sure you have no modifications that you want to keep before running init.sh.

Building

dune build

to run the tests:

dune runtest