klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2024-11-24 10:04:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated links & moved to a markdown file

Browse Source
This commit is contained in:
Julien Constant 2022-08-26 13:58:21 +02:00 committed by GitHub
parent 0470aa185e
commit 496adc17ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md Normal file
View File

@ -0,0 +1,41 @@
<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.

38
README.rst
View File

@ -1,38 +0,0 @@
.. image:: https://img.shields.io/badge/Code%20Style-Black-000000?style=for-the-badge
:target: https://github.com/ambv/black
:alt: Code style: black
.. image:: https://img.shields.io/gitlab/coverage/ae/Sith/master?gitlab_url=https%3A%2F%2Fae-dev.utbm.fr&logo=python&style=for-the-badge
:target: https://ae-dev.utbm.fr/ae/Sith/commits/master
:alt: Coverage report
.. image:: https://img.shields.io/gitlab/pipeline-status/ae/Sith?branch=master&gitlab_url=https%3A%2F%2Fae-dev.utbm.fr&label=BUILD&logo=gitlab&style=for-the-badge
:target: https://ae-dev.utbm.fr/ae/Sith/commits/master
:alt: pipeline status
.. image:: https://img.shields.io/readthedocs/sith-ae?logo=readthedocs&style=for-the-badge
:target: https://sith-ae.readthedocs.io/
:alt: Documentation report
.. image:: https://img.shields.io/discord/889796155523874847?label=Discord&logo=discord&style=for-the-badge
:target: https://discord.com/invite/YKHjY9MjkS
:alt: Discord
This is the source code of the UTBM's student association available at https://ae.utbm.fr/.
All documentation is in the ``docs`` 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.
If you want to contribute, here's how we recommend to read the docs:
* 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.
* 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.
* Keep in mind that this documentation is thought to be read in order.
To join our team :
* Send a mail at `ae.info@utbm.fr <mailto:ae.info@utbm.fr>`_
* Join our group chat on `Discord <https://discord.com/invite/YKHjY9MjkS>`_
* See and join our Trello at https://trello.com/b/YQOaF33m/site-ae.
This project is licenced under GNU GPL, see the LICENSE file at the top of the repository for more details.