📖 DOC: Complete README

sguizard · Feb 15, 2021 · d0ee9f9 · d0ee9f9
1 parent 97dd909
commit d0ee9f9
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
 # TAMA-singularity
 A definition file for building TAMA singularity container
+
+## Building container
+```
+sudo singularity build TAMA.{sif, def}
+```
+
+## Using TAMA
+There are two main Python scripts in TAMA: 
+* tama_collapse.py 
+* tama_merge.py
+
+They can be run as follows:
+
+### [tama_collapse.py](https://github.com/GenomeRIK/tama/wiki/Tama-Collapse)
+```
+singularity exec TAMA.sif tama_collapse.py -h
+```
+
+### [tama_merge.py](https://github.com/GenomeRIK/tama/wiki/Tama-Merge)
+```
+singularity exec TAMA.sif tama_merge.py -h
+```
+