home.md

@@ -18,7 +18,7 @@ The custom reference database generated by MKBDR can be use in further analysis
 # Quick start
 
 
-See [Installing MKBDR](#Installing-MKBDR) for installation instructions.
+See [Installing MKBDR](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Installing-MKBDR) for installation instructions.
 
 
 If you have installed MKBDR, you can run the example data with:
@@ -28,9 +28,46 @@ need data test
 ```
 
 
+# Software Requirements
 
-# Installing MKBDR
+* python3
+* python3 required modules included: argparse, numpy, biopython, pandas, PyQt5, ete3, pytaxize, pathlib
 
-coucou
+# Data requirements
 
+MKBDR requires:
 
+* the NCBI taxonomies files
+* formated FASTA file of the sequences with their NCBI species name
+* (optionnal) a curation CSV table file
+
+
+# Workflow
+
+![mkbdr](docs/mkbdr.png)
+
+
+# Credits
+
+**MKBDR** was coded and written by Pierre-Edouard Guerin, Laetitia Mathon and Virginie Marques.
+
+We thank the following people for their help in the development of this software: Virginie Marques, Alice Valentini, David Mouillot, Emilie Boulanger, Laetitia Mathon, Laura Benestan, Stephanie Manel, Tony Dejean.
+
+
+
+
+# Questions, comments, etc ? Contact us 
+
+:bug: If you are sure you have found a bug, please submit a bug report. You can submit your bug reports on Gitlab [here](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/issues).
+
+
+
+
+For further information or help, don't hesitate to get in touch on Slack (you can join with this invite).
+
+[![Get help on Slack](https://img.shields.io/badge/slack-cefebev%23basereference-4A154B?logo=slack)](https://cefebev.slack.com/archives/C01MDQSS57F)
+
+
+# Funding
+
+![cnrs_logo](http://www.cnrs.fr/themes/custom/cnrs/logo.svg) ![ephe_logo](https://www.ephe.psl.eu/sites/all/themes/ephenew/logo.png) ![umontpellier_logo](https://www.umontpellier.fr/wp-content/uploads/2017/01/LOGO_original_RVB_WEB-1.png)