snake/README.md

45 lines
696 B
Markdown
Raw Normal View History

2023-10-12 16:35:43 +00:00
# Snake Build System
Yet another language agnostic build system.
2023-10-12 15:59:53 +00:00
2023-10-12 16:35:43 +00:00
## Usage
None for now, but maybe one day...
## How to install
Snake relies on some libraries you must install in order to compile it.
2023-10-14 01:56:31 +00:00
- catch2 (only for testing)
- sqlite3
2023-10-12 16:35:43 +00:00
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
2023-10-14 01:56:31 +00:00
Snake is released under the GPLv3.
2023-10-12 16:35:43 +00:00
2023-10-14 01:56:31 +00:00
See the LICENSE file in the project directory for more information.