From c0361f635a58bb0c2aecde5ca969e161b726b84f Mon Sep 17 00:00:00 2001
From: Tianyou <51896128+Tianyou96@users.noreply.github.com>
Date: Thu, 29 Aug 2024 16:12:25 +0800
Subject: [PATCH] Add files via upload

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 729976e..5613362 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # SiteKIT
 
+**SiteKIT: a python toolkit for discovering the association between divergent sites and biological traits**
+
 SiteKIT can rapidly and accurately identify key sites that may be linked to specific traits. Site-trait association analysis aim to identify associations of biological traits with sites mutations. These mutations may affect gene function, thereby altering the phenotypic characteristics of organisms or causing diseases. SiteKIT provides an opportunity to gain insights into the complex relationship between site mutations and biological traits.
 
 # Installation
@@ -7,15 +9,30 @@ SiteKIT can rapidly and accurately identify key sites that may be linked to spec
 There are two ways to use SiteKIT:
 
 1. **Using the standalone executable (SiteKIT):**
+   
    - This approach involves using a pre-packaged executable that contains all necessary dependencies, making it easy to run without needing to set up a specific environment.
+   
+     ```
+     chmod +x SiteKIT
+     ```
+   
+     
+   
 2. **Configuring environment dependencies via `requirements.txt` and using the Python script (SiteKIT.py):**
+   
    - In this method, you configure the required packages by listing them in a `requirements.txt` file. Then, you can run the Python script (SiteKIT.py) within an environment that has these dependencies installed. The version of Python is 3.12.5
+   
+     ```
+     pip install -r requirements.txt
+     ```
+   
+     
 
 # Tutorial
 
 ### Parameters
 
-The `SiteKIT` tool supports various parameters to customize its behavior. You can view the help instructions by running `SiteKIT -h`.
+The `SiteKIT` tool supports various parameters to customize its behaviour. You can view the help instructions by running `SiteKIT -h`.
 
 - **`--aa_dir`**: The required input folder containing multiple sequence alignments (MSAs) of amino acids.
 - **`--group_id`**: Specifies IDs or prefixes for trait groups. Include the trait group prefix list in single quotes ('') separated by commas (,). Do not include spaces. For example: `'sample1,sample2,...'`.