Merge pull request #4 from lnp2pBot/replace-files

add justfile and readme

Author: Catrya

README.md

@@ -0,0 +1,38 @@
+# Documentation en Français
+
+[Site de la documentation en français](https://lnp2pbot.com/apprendre/)
+
+## Pour les contributeurs
+
+### Prérequis
+
+* Installer [Just](https://github.com/casey/just)
+```bash
+cargo install just
+```
+
+### Procédures
+
+#### Initialiser le projet
+
+Initialise le projet de documentation mdBook avec les dépendances requises.
+
+```bash
+just init
+```
+
+#### Servir localement
+
+Démarre un serveur de développement local avec rechargement en direct pour prévisualisation.
+
+```bash
+just serve
+```
+
+#### Compiler la documentation
+
+Génère le site de documentation statique pour le déploiement en production.
+
+```bash
+just build
+```

justfile

@@ -0,0 +1,30 @@
+# Documentation management tasks
+# Usage:
+#   just init    - Install required tools
+#   just build   - Build the documentation
+#   just serve   - Serve the documentation locally
+
+# Set the default recipe to print help
+default:
+  @just --list
+
+init:
+  #!/usr/bin/env sh
+  command -v cargo >/dev/null 2>&1 || { echo "Error: cargo is required but not installed. Please install Rust toolchain first." >&2; exit 1; }
+  echo "Installing/updating mdbook..."
+  cargo install mdbook --version 0.4.37 || { echo "Error: Failed to install mdbook" >&2; exit 1; }
+  echo "Installing/updating mdbook-admonish..."
+  cargo install mdbook-admonish --version 1.15.0 || { echo "Error: Failed to install mdbook-admonish" >&2; exit 1; }
+  echo "Setup completed successfully!"
+
+serve:
+  #!/usr/bin/env sh
+  port="3000"
+  echo "Starting documentation server on http://localhost:${port}"
+  mdbook serve --port ${port} || { echo "Error: Failed to start server" >&2; exit 1; }  
+
+build:
+  #!/usr/bin/env sh
+  echo "Building documentation..."
+  mdbook build || { echo "Error: Build failed" >&2; exit 1; }
+  echo "Build completed successfully!"