# Canary<sup>probe</sup>
Canary Probe is a simple tool to help students in Computer Programming I (CSU0001, NTNU) to test their code.
It checks about the following:
- Is the homework archive unpackable?
- Is the Makefile working?
- What are the executable files present?
## Usage
Canary<sup>probe</sup> comes with a command line tool and a library.
### Command line tool
```bash
cargo install canary-probe
canary-probe <zip-file>
```
### Library
See [docs.rs](https://docs.rs/canary-probe) for documentation.