From e1ac75f394b2cccda8af5dfc284eed8f68800da2 Mon Sep 17 00:00:00 2001 From: Sli Date: Tue, 16 Jul 2024 23:35:02 +0200 Subject: [PATCH] Rework readme and remove readthedocs config --- .readthedocs.yml | 26 -------------------------- README.md | 48 ++++++++++++++---------------------------------- 2 files changed, 14 insertions(+), 60 deletions(-) delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 481160ff..00000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,26 +0,0 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Allow installing xapian-bindings in pip -build: - apt_packages: - - libxapian-dev - -# Build documentation in the doc/ directory with Sphinx -sphinx: - configuration: doc/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - -# Optionally set the version of Python and requirements required to build your docs -python: - version: "3.8" - install: - - method: pip - path: . - extra_requirements: - - docs diff --git a/README.md b/README.md index 414681cf..f27dc28d 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,20 @@ -

- - - - - - - - - - - - -

+# Sith -

This is the source code of the UTBM's student association available at https://ae.utbm.fr/.

+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](#) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![CI status](https://github.com/ae-utbm/sith3/actions/workflows/ci.yml/badge.svg)](#) +[![Docs status](https://github.com/ae-utbm/sith3/actions/workflows/deploy_docs.yml/badge.svg)](https://ae-utbm.github.io/sith3) +[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=default&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) +[![discord](https://img.shields.io/discord/971448179075731476?label=discord&logo=discord&style=default)](https://discord.gg/xk9wfpsufm) -

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.

+### This is the source code of the UTBM's student association available at [https://ae.utbm.fr/](https://ae.utbm.fr/). -

If you want to contribute, here's how we recommend to read the docs:

+All documentation is in the `docs` directory and online at [https://ae-utbm.github.io/sith3](https://ae-utbm.github.io/sith3). 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. > This project is licensed under GNU GPL, see the LICENSE file at the top of the repository for more details.