{"repo":"carpentry-org/template","free":true,"listed":false,"github":"https://github.com/carpentry-org/template","clone":"git clone https://github.com/carpentry-org/template.git","description":"A template for structuring your Carp packages","language":null,"stars":18,"topics":["template","template-repository","carp"],"license":null,"category":"saas-starters-boilerplates","readme_excerpt":"template This is a Carp template repository. You should be able to reuse its structure for your projects! Overview The module lives in my-mod.carp , named after the MyMod module it holds. That is the convention the carpentry-org packages follow, so rename both the file and the module for your own library. Four places refer to the name and need to change with it: - test/my-mod.carp , which loads it - gendocs.carp , which loads it and sets the docs title - .github/workflows/ci.yml , which runs the test file - the module's own doc string in my-mod.carp my-mod.carp also shows the two definition forms you will use most: defn for public functions, each with a doc string, and defn- for helpers that should stay inside the module and out of the generated docs. Tests Tests live in test/my-mod.carp and run with carp -x test/my-mod.carp . The two that ship here pass, so a red suite means you broke something. Replace them with tests for your own library. Documentation carp -x gendocs.carp generates documentation from the doc strings of your functions and modules and writes it to docs/ . Style it by editing the CSS or the configuration options in gendocs.carp , which should be pretty self-explanatory. Set docs-url to your repository, and note that title also names the generated index page. A single-module project does not need that index at all; uncomment docs-generate-index once yours is one. CI The workflow runs the tests, then lints with angler and checks formatting with carp-fmt, then ","default_branch":null,"files":null,"tree":[],"storefront":"/r/carpentry-org","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/carpentry-org/template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}