~brenns10/sc-template

49f930f119c7edd3f9bc3614a4cafea2e0e2bc08 — Stephen Brennan 1 year, 1 month ago bfed01d
Update README
1 files changed, 14 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +14 -1
@@ 2,7 2,8 @@ sc-template
===========

This serves as a template which I can use to quickly create a new "sc-" library.
Copy and paste this directory and update the following files:
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


@@ 11,6 12,18 @@ Copy and paste this directory and update the following files:
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
-----------