You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zapashcanon 5547b1a14c
update .ocamlformat
1 year ago
src update .ocamlformat config 1 year ago
.gitignore first commit 3 years ago
.ocamlformat update .ocamlformat 1 year ago
CHANGES.md update .ocamlformat config 1 year ago
LICENSE.md improve doc 1 year ago
README.md improve doc 1 year ago
dune-project improve doc 1 year ago
gotd.opam improve doc 1 year ago

README.md

gotd

gotd is an OCaml executable to quickly start an OCaml project.

Installation

gotd can be installed with opam:

opam install gotd

If you don't have opam, you can install it following the how to install opam guide.

If you can't or don't want to use opam, consult the opam file for build instructions.

Quickstart

$ gotd sozet

Will create a directory named sozet containing a skeleton OCaml project. In some places, there'll be some TODOs that you can fix later.

If you want to customize what's generated, simply write a configuration file for gotd in ${XDG_CONFIG_HOME:-~/.config}/gotd/config.scfg with the following content adapted to your needs:

author          "Léo Andrès <contact@ndrs.fr>"
bug_prefix      https://git.zapashcanon.fr/zapashcanon/
bug_suffix      /issues
doc_prefix      https://doc.zapashcanon.fr/
doc_suffix      ""
homepage_prefix https://git.zapashcanon.fr/zapashcanon/
homepage_suffix ""
license         ISC
maintainer      "Léo Andrès <contact@ndrs.fr>"
source_prefix   git+https://git.zapashcanon.fr/zapashcanon/
source_suffix   .git

When creating a project, the bug address will be bug_prefix ^ project_name ^ bug_suffix. E.g. on a project called sozet, with my configuration it would be https://git.zapashcanon.fr/zapashcanon/sozet/issues.

About