Update README.md

yhg926 · Dec 22, 2021 · ae6653c · ae6653c
1 parent 84a5f7c
commit ae6653c
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,16 @@
 # TQSLE
 TQSLE v1.0 released
 
+author: Huiguang Yi ([email protected])
+
 Current version is based on x86_64 linux system 
 
-Dependencies:
+## Dependencies:
 1. gcc && gfortran
 2. intel mkl BLAS (Recommended) or OpenBLAS or native BLAS (not Recommended)
 3. SuiteSparse (need CHOLMOD module)
 
-Install:
+## Install:
 
 If intel mkl is available
 ```
@@ -22,3 +24,11 @@ Else Use OpenBLAS in the repo
 ```
 make
 ```
+## Usage:
+```
+# index construction
+tqsle index -f<mean fragment size> -i <reference.fa> -o <outpath>
+
+# quantification 
+tqsle quant -i <indexpath> -o <outputpath>
+```