{"id":16743938,"url":"https://github.com/zshipko/ocaml-rust-starter","last_synced_at":"2025-03-17T01:32:11.940Z","repository":{"id":38147352,"uuid":"259416831","full_name":"zshipko/ocaml-rust-starter","owner":"zshipko","description":"Getting started with ocaml-rs","archived":false,"fork":false,"pushed_at":"2024-08-31T19:19:52.000Z","size":23,"stargazers_count":31,"open_issues_count":3,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-27T16:38:25.858Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zshipko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-27T18:24:31.000Z","updated_at":"2024-08-31T19:19:55.000Z","dependencies_parsed_at":"2024-10-27T11:52:05.127Z","dependency_job_id":"a988c18b-a1b1-43a3-a98c-09f705958cf7","html_url":"https://github.com/zshipko/ocaml-rust-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zshipko%2Focaml-rust-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zshipko%2Focaml-rust-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zshipko%2Focaml-rust-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zshipko%2Focaml-rust-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zshipko","download_url":"https://codeload.github.com/zshipko/ocaml-rust-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243836967,"owners_count":20355805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T01:42:01.858Z","updated_at":"2025-03-17T01:32:11.569Z","avatar_url":"https://github.com/zshipko.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ocaml-rust-starter\n\nAn example project using [ocaml-rs](https://github.com/zshipko/ocaml-rs) to call Rust functions from OCaml.\n\nIf you're looking for an example of linking an OCaml library into a Rust program take a look at [rust-ocaml-starter](https://github.com/zshipko/rust-ocaml-starter)\n\n## New project checklist\n\n- [ ] Update `README.md`\n- [ ] Update the project name in `dune-project`\n- [ ] Update the crate name in `Cargo.toml`\n- [ ] Update `src/dune` and `test/dune` with the name of your project in place of `ocaml_rust_example`/`ocaml-rust-example`\n- [ ] Rename `ocaml-rust-starter.opam` to match the name of your project\n- [ ] Remove `src/ocaml_rust_example.ml` and `src/ocaml_rust_example.mli` and add your own OCaml files\n- [ ] Update `build.rs`\n- [ ] Edit `src/lib.rs`\n- [ ] Add your tests to `test/test.ml`\n- [ ] Use `cargo vendor` if you intend to make the project installable using opam\n\nMany of the renaming steps can be automated using `init.sh`:\n\n```shell\n$ ./init.sh my_project my-project\n```\n\n`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.\n\nNOTE: `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`.\n\n## Building\n\n    dune build\n\nto run the tests:\n\n    dune runtest\n\nto load your library into an interactive sesssion:\n\n  OCAML_INTEROP_NO_CAML_STARTUP=1 dune utop\n\nThe `OCAML_INTEROP_NO_CAML_STARTUP` environment variable should be set to ensure\nthe library is linked correctly.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzshipko%2Focaml-rust-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzshipko%2Focaml-rust-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzshipko%2Focaml-rust-starter/lists"}