Hojgaetan/LMS

Améliorer la documentation d'installation pour Linux/macOS

Open

#6 opened on Sep 30, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (2 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Difficulté: 🟢 Facile Temps estimé: 1-2 heures

Description: Le README.md contient actuellement uniquement les instructions d'installation pour Windows. Ajoutez les instructions pour Linux et macOS.

Tâches:

  • Ajouter une section "Installation & Setup (Linux/macOS)" dans le README.md
  • Inclure les commandes bash équivalentes pour python -m venv venv et l'activation
  • Tester les instructions sur au moins une distribution Linux ou macOS
  • Ajouter des notes sur les prérequis (Python 3.10+, pip)

Fichiers à modifier:

  • README.md

Critères d'acceptation:

  • Les instructions fonctionnent sur Linux/macOS
  • Le formatage est cohérent avec le style existant
  • Les commandes sont correctes et testées

Contributor guide

Research direction
Identify the equivalent bash commands for creating and activating a Python virtual environment on Linux and macOS, then add them to the README.md following the existing format.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python 3.10+
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90