add documents

README.md

@@ -9,20 +9,9 @@
 
 ## Current Tools
 
-| Tool                    | Description                         | Status                                                         |
-|-------------------------|-------------------------------------|----------------------------------------------------------------|
-| [boss-fqsp](#boss-fqsp) | Fastq Splitter for Paired End Reads | ![boss-fqsp](https://img.shields.io/badge/Version-1.0.0-green) | 
-
-
-
-
-## Usage
-
-### boss-fqsp
-
-```console
-boss-fqsp -h
-```
+| Tool                               | Description                         | Status                                                         |
+|------------------------------------|-------------------------------------|----------------------------------------------------------------|
+| [boss-fqsp](document/boss-fqsp.md) | Fastq Splitter for Paired End Reads | ![boss-fqsp](https://img.shields.io/badge/Version-1.0.0-green) | 
 
 ## How to build
 
@@ -135,4 +124,5 @@ Ccache can be enabled by configuring with `-DUSE_CCACHE=<ON | OFF>`.
 - https://github.com/TheLartians/ModernCppStarter
 
 ## License
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcauliyang%2Fboss.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcauliyang%2Fboss?ref=badge_large)

document/boss-fqsp.md

@@ -0,0 +1,65 @@
+# Document for FQSP
+
+## Aim
+
+`boss-fqsp` is used to split one fastq file into two fastq files. The format of the input fastq file is as follows:
+
+```text
+@SRR8618317.1.1 1 length=101
+CAGTGCTCAGCTTGCACCCTGGCACAGGCCAGCAGTTGCTGGAAGTCAGACACCCGGTGCTGGCAATCTCGTTTAAACTACATGCAGGAACAGCAAAGGAA
++SRR8618317.1.1 1 length=101
+?????????????????????????????????????????????????????????????????????????????????????????????????????
+@SRR8618317.1.2 1 length=101
+CCGGTGTTGAGAATGACTGCGCAAATTTGCCGGATTTCCTTTGCTGTTCCTGCATGTAGTTTAAACGAGATTGCCAGCACCGGGTGTCTGACTTCCAGCAA
++SRR8618317.1.2 1 length=101
+?????????????????????????????????????????????????????????????????????????????????????????????????????
+@SRR8618317.2.1 2 length=101
+GTTGAGAATGACTGCGCAAATTTGCCGGATTTCCTTTGCTGTTCCTGCATGTAGTTTAAACGAGATTGCCAGCACCGGGTATCATTCACCATTTTTCTTTT
+```
+
+Every four lines are belong to one end of paired reads.
+
+## Usage
+
+```console
+fqsp - A program to split ncbi fq files into forward and reverse files.
+Usage:
+  boss-fqsp [OPTION...] [input.fq|.fq.gz]
+
+  -h, --help        Show help
+  -v, --version     Print the current version number
+  -o, --output arg  Output fq file
+  -d, --debug       Enable debug mode
+```
+
+* Example 1
+
+The result `example.1.fq`  and `example.2.fq` will be written.
+
+```console
+$ boss-fqsp example.fq
+```
+
+* Example 2
+
+The result `example.1.fq.gz` and `example.2.fq` will be written.
+
+```console
+$ boss-fqsp example.fq.gz
+```
+
+## Performance
+
+**NOTE**: The performance is tested simply by `time` command. It is not a benchmark.
+
+| File Size | Format | Time |
+|-----------|--------|------|
+| 1.2G      | fq.gz  | 0.2s |
+| 1.2G      | fq     | 0.2s |
+
+## Current Issues
+
+
+
+
+