chore: license and readme
This commit is contained in:
parent
ad747a25cb
commit
43540a9d7d
|
@ -0,0 +1,25 @@
|
||||||
|
Copyright (c) 2023 thetek
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any
|
||||||
|
person obtaining a copy of this software and associated
|
||||||
|
documentation files (the "Software"), to deal in the
|
||||||
|
Software without restriction, including without
|
||||||
|
limitation the rights to use, copy, modify, merge,
|
||||||
|
publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software
|
||||||
|
is furnished to do so, subject to the following
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice
|
||||||
|
shall be included in all copies or substantial portions
|
||||||
|
of the Software.
|
||||||
|
|
||||||
|
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 OR COPYRIGHT HOLDERS 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.
|
|
@ -0,0 +1,33 @@
|
||||||
|
# C Template
|
||||||
|
|
||||||
|
A template for C programs. Its features include:
|
||||||
|
|
||||||
|
- Sane defaults (especially compiler flags)
|
||||||
|
- A custom build system written in Python
|
||||||
|
- Simple custom testing framework
|
||||||
|
- Formatting using `clang-format`
|
||||||
|
- Common functions and typedefs included
|
||||||
|
- Simple logging library
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# debug build
|
||||||
|
build/build.py
|
||||||
|
build/build.py debug
|
||||||
|
|
||||||
|
# release build
|
||||||
|
build/build.py release
|
||||||
|
|
||||||
|
# run tests
|
||||||
|
build/build.py test
|
||||||
|
|
||||||
|
# format source files
|
||||||
|
build/build.py fmt
|
||||||
|
|
||||||
|
# clean build files
|
||||||
|
build/build.py clean
|
||||||
|
```
|
||||||
|
|
||||||
|
Source files are located in `src/`, header files are located in `inc/` and
|
||||||
|
anything used for testing goes in `test/`.
|
Loading…
Reference in New Issue