From 0436fe40900c89c6e655d813a5338ac3928914a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Boris=20Cl=C3=A9net?= Date: Fri, 13 Oct 2023 12:01:58 +0200 Subject: [PATCH] [DOC] new readme for the doc --- docs/README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8c4fd662..f2c9a77e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,13 +2,16 @@ :mega: This is the starting point for the documentation of the NARPS open pipelines project. -Here are the available topics : - -* :runner: [running](/docs/running.md) tells you how to run pipelines in NARPS open pipelines -* :brain: [data](/docs/data.md) contains instructions to handle the data needed by the project -* :hammer_and_wrench: [environment](/docs/environment.md) contains instructions to handle the software environment needed by the project -* :goggles: [description](/docs/description.md) tells you how to get convenient descriptions of the pipelines, as written by the teams involved in NARPS. -* :microscope: [testing](/docs/testing.md) details the testing features of the project, i.e.: how is the code tested ? -* :package: [ci-cd](/docs/ci-cd.md) contains the information on how continuous integration and delivery (knowned as CI/CD) is set up. -* :writing_hand: [pipeline](/docs/pipelines.md) tells you all you need to know in order to write pipelines -* :vertical_traffic_light: [status](/docs/status.md) contains the information on how to get the work progress status for a pipeline. +## Use the project +* :brain: [data](/docs/data.md) - handle the data needed by the project +* :hammer_and_wrench: [environment](/docs/environment.md) - handle the software environment needed by the project +* :rocket: [running](/docs/running.md) - launch pipelines in NARPS open pipelines + +## Contribute to the code +* :goggles: [description](/docs/description.md) - conveniently access descriptions of the pipelines, as written by the teams involved in NARPS. +* :writing_hand: [pipeline](/docs/pipelines.md) - how to write pipelines. + +## Main +* :vertical_traffic_light: [status](/docs/status.md) - work progress status for a pipeline. +* :microscope: [testing](/docs/testing.md) - testing features of the project, i.e.: how is the code tested ? +* :package: [ci-cd](/docs/ci-cd.md) - how continuous integration and delivery (knowned as CI/CD) is set up.