diff --git a/README.md b/README.md index c0f70571cecf186a2aa764f498a14f12f71e8e76..d181450de5f7c42c5461bdaaea215b4438aaee86 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -## Read sequencer +# Read Sequencer + +## Overview + +Read Sequencer is a test phyton package to simulate Sequencing. +It reads fasta files, simulate sequencing and writes the resulting sequences into a new fasta file. + + +## Installation + +To install the latest release from GitHub: + +``` +if (!requireNamespace("remotes", quietly = TRUE)) + install.packages("remotes") +remotes::install_github(".../Read_Sequencer") + +``` + +## Contributors and Contact Information + +Christop Hamel - christoph.harmel@unibas.ch +Michael Sandholzer - michael.sandholzer@unibas.ch +Clara Serger - c.serger@unibas.ch +