diff --git a/README.md b/README.md index 96ce893..45ecfaf 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ and using Python to solve problems or automate tasks. ## Getting Started +Sequencing File Conveter allows the user to swap the format of their nucleic acid sequencing file (allowed file types: .qseq, .fastq, or .sam). Please refer to the seqfileconverter usage diagram to view the current supported swaps. + ### Prerequisites Utility scripts are written in Python3. @@ -29,9 +31,9 @@ Tests have not yet been created for this repository. ### Usage -To run file converter: +To run sequencing file converter: ``` -python +python seqfileconverter -f -o -d -m -t ``` ## Contributing @@ -39,7 +41,7 @@ python This is a beginner, educational repository for students learning Python or R to contribute to. We are a small group of students at CSU studying biology and learning code through hands-on activities, please contact a member through the webpage to ask about joining before you contribute to this repository. ### Proposed ideas: -* qSeq-FastQ converter +* qSeq to/from SAM file converter (can be added as a module to seqfileconverter) * demultiplex libraries ## Authors