diff --git a/docs/index.md b/docs/index.md index 09893ff9b14c3681e914c61605597ada77fb95cb..bf3689122edc9d407e758f4d69c4901ee622fc3e 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 90818a45fd8dcb495982f68f1999a4f3d29fe8c1..32417cd8676ed6bbfcffb13641f3f03ffc347448 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: