From bf2e76193f3b8f22a387bf35105c1f7bbb2fe05d Mon Sep 17 00:00:00 2001 From: ccialek <42818380+ccialek@users.noreply.github.com> Date: Sun, 27 Jan 2019 16:04:20 -0700 Subject: [PATCH 1/2] Added the line of command --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96ce893..d4bf6d4 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,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 From 92ce6ccdec45f66ed6c6f4211e6aed77bf6064f4 Mon Sep 17 00:00:00 2001 From: ccialek <42818380+ccialek@users.noreply.github.com> Date: Sun, 27 Jan 2019 16:17:22 -0700 Subject: [PATCH 2/2] Added info for seqfileconverter users Added basic info about the code under "getting started". I wanted to embed the diagram of how the converter works, but it didn't seem like I could do that... I'll upload it to the repo and if anyone has a better place for it then please move it there! --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d4bf6d4..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. @@ -39,7 +41,7 @@ python seqfileconverter -f -o -d -m