Just run setup.sh to set up a ready-for-development OCaml environment.
- Makefile supporting rules:
buildruninstall,uninstallfmt(formatting using ocamlformat)cleantest(run alcotest tests)debug(using ocamldebug)docs(documentation generation)push(build, clean, etc. then push to origin/main provided a commit message)
- Argument parsing
- Logging
- Github CI:
- Build and Test
- Build and publish docs to
gh-pagesbranch for automatic documentation publication
Project description and synopsis should not include single quotes.
Once you modify docs/PROJECT_NAME.mld to contain multiple sections, the up - PROJECT_NAME navigation at the top of the index page will disappear, and a navigation sidebar will replace it.
The default license generated is MIT, but feel free to change it. THIS TEMPLATE IS LICENSED UNDER THE UNLICENSE
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to https://unlicense.org