From b81865f1a33f7d1e56e2eac3490c4529cf72bbf3 Mon Sep 17 00:00:00 2001 From: Jean-Marie 'Histausse' Mineau Date: Sat, 30 May 2026 19:12:22 +0200 Subject: [PATCH] update readme --- README.md | 40 +++++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f33124a..91b95f4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,35 @@ # ISN-s-Cube + A 3D Rubik's Cube with a solver. It's a french A-level Project, so it's in french, sorry for that. -This program runs with Python3. -You need pygame installed in your computer. -To install pygame, execute the command `python -m pip install pygame` (in windows) or -`sudo pip3 install pygame` (in GNU Linux. You need pip3 installed before: `sudo apt-get install python3-pip`) +The original program was written in 2015 and has been packaged in 2026. +To run it, you need python 3 installed. Then install the packaged in a virtual environment, and run `isn-s-cube`: -Ce programme tourne sous Python3. -Vous avez besoin de pygame installé sur votre ordinateur. -Pour installer pygame, executez `python -m pip install pygame` (sous windows) ou -`sudo pip3 install pygame` (sous GNU Linux. Vous avez besoin de pip3 installé -avant: `sudo apt-get install python3-pip`) +``` +python3 -m venv venv +source venv/bin/activate +pip install 'git+https://git.mineau.eu/histausse/ISN-s-Cube.git' +isn-s-cube +``` + +--- + +Un résolveur de Rubik's Cube avec un affichage 3D. +C'est un project d'ISN (Informatique et Sciences Numérique) pour le bac. +Pour les jeunes qui ne connaissent pas, ISN était une spécialisation pour la fillière S (scientifique), à l'époque ou les fillières existaient encore... +C'était la seule façon de faire de l'informatique au lycée avant la réforme (si on ne compte pas les algorithmes papier en math qui ne dépassaient pas le calcul d'un PGCD). + +Le programe originale a été écrit en 2015, et a été packagé en 2026. +Pour le lancer, vous avez besoin d'avoir python 3 d'installé. Ensuite, dans installez le package dans un venv, puis lancer la commande `isn-s-cube`: + +``` +python3 -m venv venv +source venv/bin/activate +pip install 'git+https://git.mineau.eu/histausse/ISN-s-Cube.git' +isn-s-cube +``` + +# Authors / Auteurs + +- Jean-Marie 'Histausse' Mineau +- Maxime Keller