Skip to content

Commit e4226d0

Browse files
readme stuff
1 parent abc0ba0 commit e4226d0

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
11

2-
## Getting started
2+
## Getting Started
33

44
There are three options to get MA running:
5-
1. The installer
6-
2. Cloning & Compiling
7-
3. using pip (coming soon)
85

9-
### The installer
6+
#### 1. The Installer
107

11-
The installer is available on the It-Be homepage:
8+
An installer is available on the It-Be homepage:
129

1310
http://itbe.hanyang.ac.kr/research-articles/alignment/
1411

15-
The installer is for 64bit **Windows** only.
12+
Note: The installer is currently the only way to obtain the GUI version of MA.
1613

17-
18-
### Cloning & Compiling
14+
#### 2. Cloning & Compiling
1915
This software uses boost 1.65.
2016

21-
After downloading, set $(BOOST_ROOT) then execute following commands:
17+
After installing boost, set $(BOOST_ROOT) and execute following commands:
2218

2319
git clone https://github.com/ItBeLab/ma
2420
cd ma
2521
make
2622
./ma -h
2723

28-
### Pip
24+
#### 3. Pip
2925

3026
coming soon!
3127

28+
### Aligning
29+
30+
@todo
31+
32+
### Generating Reference Indices
33+
34+
@todo
35+
3236
## Introduction
3337

3438
@todo
@@ -39,4 +43,5 @@ MA is unpublished so far.
3943

4044
## The It-Be Lab
4145

42-
The homepage of the **Information Technology – Bio Engineering** Lab at Hanyang University can be found here http://itbe.hanyang.ac.kr/.
46+
The homepage of the **Information Technology – Bio Engineering** Lab
47+
at Hanyang University can be found here http://itbe.hanyang.ac.kr/.

0 commit comments

Comments
 (0)