aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 2a80f892bf5768e713c8e19d5c762ce85a148860 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
A self assessment tool for learning languages.

**UNDER CONSTRUCTION**

## Contributing

This application is built like any other Rust project:

```
$ cargo build
```

In order to test things you need to provide a database for it. One is provided
in the form of `testdata/test.sqlite3`. So take that and set the `MIHI_DATABASE`
environment variable to its full path. And after that you will be able to run:

```
$ cargo test
$ cargo clippy --all-targets --all-features
```

## License

This repository holds two licenses, as you can also note on the `Cargo.toml`
file. As it's written there:

- The source code on the `crates/` directory is licensed under the GNU GPLv3 (or
  any later version).
- The source code on the `lib/` directory is licensed under the GNU LGPLv3 (or
  any later version).

In practice, for the libraries under `lib/` this means that if you plan to
compile your binary statically, you still need to abide by the LGPLv3+ license.
This means at least providing the object files necessary to allow someone to
recompile your program using a modified version of these libraries. See the
LGPLv3 license for more details.