From 4cdecd215a097e16ffbf24c7a4adaf1db99b94b0 Mon Sep 17 00:00:00 2001 From: KHAM Chaimae <k24022051@V-PP-47-L-145.salsa.univ-amu.fr> Date: Fri, 8 Nov 2024 16:14:39 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20du=20README.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 69a47ca..a60d814 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ -# Projet R avec Apptainer +#Project Setup and Execution Guide -Ce projet exécute automatiquement quatre scripts R à l'aide d'Apptainer. +This README explains the process for setting up the required environment and running R scripts using micromamba and Apptainer. The guide is divided into two main steps: installation and execution. -## Installation +#Prerequisites -Pour l'installation et la configuration, suivez les instructions dans doc/01install.md +Ensure you have the following installed: + curl + tar + sudo access (for building Apptainer images) + Make utility (for running make commands) + +#Installation Script (01.install.md) -## Exécution +Refer to and follow the steps in the script "01.install.md" to install and configure micromamba, create the necessary environment, and build the Apptainer container image. This step sets up everything required for running the project in a reproducible environment. -Pour exécuter les scripts, reportez-vous à doc/02run.md +#Execution Script (02run.md) + +After completing the installation, follow the steps in the file "02run.md" to activate the environment and execute the R scripts defined in the makefile inside the Apptainer container. -## Version -Version : 0.1.0 -- GitLab