Skip to content

Commit 35d8de6

Browse files
committed
Improved the documentation.
1 parent 6c69b2f commit 35d8de6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Running in python3 also yields ~11% speed gains relatively to python2 (altough t
1414

1515
## Installation
1616

17-
Just clone the repository, and place the contents, respecting the directory
18-
structure in your $PATH.
17+
Just clone the repository (or download one of the releases), and place the contents, respecting the directory structure in your $PATH.
18+
Alternatively, you can also place the program somewhere, and call it from your current dir using the full path.
1919

2020
You can go the the "helper_scripts" directory where you will find some scripts to help you install both *Structure* and *fastStructure*.
2121

@@ -92,7 +92,7 @@ The directory "TestData" in the repository contains some test data that was used
9292
You can find documentation about it inside the directory itself.
9393

9494

95-
## Benchmarking processed
95+
## Benchmarking process
9696

9797
You can find some of the scripts used for the benchmarking process inside the *benchmark* directory. Further documentation on this topic can be found inside the directory itself.
9898

@@ -106,7 +106,7 @@ The scripts "harvesterCore.py" and "structureHarvester.py" were taken from [the
106106

107107
## Citation
108108

109-
If you use Structure_threader, please cite
109+
If you use *Structure_threader*, please cite
110110

111111
* Coming soon (hopefully)!
112112

0 commit comments

Comments
 (0)