Skip to content

Commit

Permalink
readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkusRainerSchmidt committed Mar 12, 2018
1 parent abc0ba0 commit e4226d0
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@

## Getting started
## Getting Started

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

### The installer
#### 1. The Installer

The installer is available on the It-Be homepage:
An installer is available on the It-Be homepage:

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

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


### Cloning & Compiling
#### 2. Cloning & Compiling
This software uses boost 1.65.

After downloading, set $(BOOST_ROOT) then execute following commands:
After installing boost, set $(BOOST_ROOT) and execute following commands:

git clone https://github.com/ItBeLab/ma
cd ma
make
./ma -h

### Pip
#### 3. Pip

coming soon!

### Aligning

@todo

### Generating Reference Indices

@todo

## Introduction

@todo
Expand All @@ -39,4 +43,5 @@ MA is unpublished so far.

## The It-Be Lab

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

0 comments on commit e4226d0

Please sign in to comment.