Skip to content

Commit 2f7d864

Browse files
author
Adrienn Szabo
committed
readme update
1 parent eef4589 commit 2f7d864

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ ProteinPatternSearch
33

44
This repository includes Java classes that do the pre-processing steps
55
of filtering transmembrane protein fragments from the SwissProt protein database.
6-
Project details can be read in Chapter 5 of [my thesis](https://info.ilab.sztaki.hu/~aszabo/aszabo_thesis.pdf)
6+
Project details can be read in Chapter 5 of [my dissertation](https://www.dropbox.com/s/cow9vys7wrl1kqj/thesis_aszabo.pdf?dl=0)
77

88
#### The tasks this software package is able to perform are:
99

@@ -38,14 +38,17 @@ output files instead of kClust results.
3838

3939
## How to use
4040

41-
TODO
41+
### A) Compile
4242

43-
### A) Compile and run
43+
To compile the java project, first get [Gradle](http://gradle.org/) (version 1.6 or above), and the run:
4444

45-
gradle build
45+
gradle build
4646

4747

4848
### B) Run the whole pipeline
4949

50+
The easiest way to get a working example is to follow the scripts and configs as described in my [dissertation](https://www.dropbox.com/s/cow9vys7wrl1kqj/thesis_aszabo.pdf?dl=0). There you will see where are the lines in the configs that should be changed to execute the programs on your files, with your parameters.
51+
52+
5053

5154

0 commit comments

Comments
 (0)