Add Contributing and License sections to README #41

Merged
HEL merged 2 commits from feat/readme-additions into main 2026-07-09 22:39:09 +00:00

View File

@@ -1,5 +1,9 @@
<h1>Midas</h1>
<p align="center">
<img src="assets/icon.svg" width="64">
</p>
<img src="https://git.kb28.ch/HEL/midas/actions/workflows/tests.yaml/badge.svg">
*Midas* is a type system to _Maintain Integrity of Data with Annotated Structures_. In Greek mythology, [Midas](https://en.wikipedia.org/wiki/Midas) was a Phrygian king who was blessed with the gift of turning everything he touched into gold.
@@ -24,6 +28,8 @@ This framework is being developed as part of a Bachelor's Thesis by Louis Herede
- [Showing Type Judgements](#showing-type-judgements)
- [Validating Definitions](#validating-definitions)
- [Tests](#tests)
- [Contributing](#contributing)
- [License](#license)
</details>
@@ -163,3 +169,16 @@ Not specifying any subcommand is equivalent to running `run -a`
- Run specific tests: `run tests/cases/test1.py tests/cases/test2.py ...`
- Update all tests: `update -a`
- Update specific tests: `update tests/cases/test1.py tests/cases/test2.py ...`
## Contributing
Feel free to [open an issue](https://git.kb28.ch/HEL/midas/issues) to report a bug or if you experience any issues with Midas.
Contributions are also welcome so feel free to [open a pull request](https://git.kb28.ch/HEL/midas/pulls).
> [!NOTE]
> As this is part of my bachelor project, I will not accept any contributions before my defense
## License
Midas is distributed under the terms of the Apache-2.0 license. See [LICENSE](LICENSE) for details.