From f912b4ba8b4ec1ee73b0bcd839d89f29a1ad815b Mon Sep 17 00:00:00 2001
From: Fontrodona Nicolas <nicolas.fontrodona@ens-lyon.fr>
Date: Mon, 3 Jul 2023 17:59:28 +0200
Subject: [PATCH] docs/index.md mkdocs.yml: update
---
docs/index.md | 21 +++++----------------
mkdocs.yml | 2 +-
2 files changed, 6 insertions(+), 17 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 09893ff..bf36891 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,21 +1,10 @@
# IliBaDe
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+`IliBaDe` stands for In-line Barcode De-muliplexing. It's a tool that allow to split a fastq file into mutlple fastq based on the presence in the read of an inline barcode
-## Commands
+## Prerequisites
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+The tool was developed using python 3 and the following dependensies:
-## Project layout
-
- mkdocs.yml # The configuration file.
- docs/
- index.md # The documentation homepage.
- ... # Other markdown pages, images and other files.
-
-# Title 2
-
-Lol test
\ No newline at end of file
+- [Lazyparser](https://github.com/NFontrodona/Lazyparser)
+- [biopython](https://biopython.org/)
diff --git a/mkdocs.yml b/mkdocs.yml
index 90818a4..32417cd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -19,7 +19,7 @@ markdown_extensions:
nav:
- Documentation:
- - documentation/index.md
+ - index.md
- Principle: documentation/principle.md
- Usage: documentation/usage.md
- Reference:
--
GitLab