mirror of
https://github.com/ae-utbm/sith.git
synced 2024-11-16 19:23:27 +00:00
42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
|
<p align="center">
|
||
|
|
<a href="#">
|
||
|
|
<img src="https://img.shields.io/badge/Code%20Style-Black-000000?style=for-the-badge">
|
||
|
|
</a>
|
||
|
|
<a href="#">
|
||
|
|
<img src="https://img.shields.io/github/checks-status/ae-utbm/sith3/master?logo=github&style=for-the-badge&label=BUILD">
|
||
|
|
</a>
|
||
|
|
<a href="https://sith-ae.readthedocs.io/">
|
||
|
|
<img src="https://img.shields.io/readthedocs/sith-ae?logo=readthedocs&style=for-the-badge">
|
||
|
|
</a>
|
||
|
|
<a href="https://discord.gg/XK9WfPsUFm">
|
||
|
|
<img src="https://img.shields.io/discord/889796155523874847?label=Discord&logo=discord&style=for-the-badge">
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3 align="center">This is the source code of the UTBM's student association available at https://ae.utbm.fr/.</h3>
|
||
|
|
|
||
|
|
<p align="justify">All documentation is in the <code>docs</code> directory and online at https://sith-ae.readthedocs.io/. This documentation is written in French because it targets a French audience and it's too much work to maintain two versions. The code and code comments are strictly written in English.</p>
|
||
|
|
|
||
|
|
<h4>If you want to contribute, here's how we recommend to read the docs:</h4>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p align="justify">
|
||
|
|
First, it's advised to read the about part of the project to understand the goals and the mindset of the current and previous maintainers and know what to expect to learn.
|
||
|
|
</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p align="justify">
|
||
|
|
If in the first part you realize that you need more background about what we use, we provide some links to tutorials and documentation at the end of our documentation. Feel free to use it and complete it with what you found helpful.
|
||
|
|
</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p align="justify">
|
||
|
|
Keep in mind that this documentation is thought to be read in order.
|
||
|
|
</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
> This project is licenced under GNU GPL, see the LICENSE file at the top of the repository for more details.
|
||
|
|
|