~brenns10/sc-template

ref: 49f930f119c7edd3f9bc3614a4cafea2e0e2bc08 sc-template/README.md -rw-r--r-- 1.1 KiB
49f930f1Stephen Brennan Update README 1 year, 2 months ago

#sc-template

This serves as a template which I can use to quickly create a new "sc-" library. Copy and paste this directory (cp -PR sc-template DESTINATION) and update the following files:

  • README.md: replace this text with a description of the project
  • CHANGELOG.md: create a remark for version 0.0.0 and add the date
  • meson.build: replace the ALL CAPS contents with proper values

All remaining files need not be modified. Place C source directories into the src dir and public headers into include.

Commands for updating a repository:

TEMPLATE=path/to/sc-template
cd path/to/repo/to/update
cp $TEMPLATE/.gitignore .
cp $TEMPLATE/.pre-commit-config.yaml .
cp $TEMPLATE/.clang-format .
cp $TEMPLATE/LICENSE .
cp -P $TEMPLATE/compile_commands.json .

#Development

Run the following to create a build directory:

meson build

You may then compile (or re-compile) with:

ninja -C build

When you would like to commit your changes, please ensure that you have pre-commit hooks installed, so that automated checks can run on your code:

pre-commit install