43 lines
678 B
Markdown
43 lines
678 B
Markdown
# Snake Build System
|
|
Yet another language agnostic build system.
|
|
|
|
## Usage
|
|
None for now, but maybe one day...
|
|
|
|
## How to install
|
|
Snake relies on some libraries you must install in order to compile it.
|
|
|
|
- catch2 (for testing)
|
|
|
|
First, you need to compile Snake using the given Makefile:
|
|
|
|
```bash
|
|
make
|
|
```
|
|
|
|
Before installing, you can run the tests using the following commands:
|
|
|
|
To run the test suite:
|
|
```bash
|
|
make test
|
|
```
|
|
|
|
To run static tests:
|
|
|
|
```bash
|
|
make check
|
|
```
|
|
|
|
Then you can install Snake this way:
|
|
|
|
```bash
|
|
sudo make install
|
|
```
|
|
|
|
## How to contribute
|
|
Don't.
|
|
|
|
## License
|
|
Snake is released under the GPLv3.
|
|
|
|
See the LICENSE file at the project's root for more information. |