From c1b7df1172a9ddf13ff354f06752072f93439a4e Mon Sep 17 00:00:00 2001
From: Guoyi Zhang <kuoi@bioarchlinux.org>
Date: Tue, 7 May 2024 12:52:23 +0800
Subject: [PATCH] add: README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..576ceb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+
+- Author: Guoyi Zhang
+
+- License: GPLv2
+
+## gene_marker
+
+Generate fasta file which `m` means selected position by Gblocks from Gblocks html report file.
+
+Usage:
+
+```
+gene_marker <input_file> <output_file>
+```
+
+## trim_marker
+
+Trim the multi-sequence-alignment based on the marker which `m` indicates selected position.
+
+Usage:
+
+```
+trim_marker <marker_fasta_file> <input_fasta_file> <output_file>
+```