| 1 |
************************************************ |
| 2 |
* README of trunks |
| 3 |
************************************************ |
| 4 |
Author: Maria Hartmann |
| 5 |
Date: 31 May 2013 |
| 6 |
************************************************ |
| 7 |
|
| 8 |
* Installation: |
| 9 |
As long as the preprocessor directive TEST_MODE is not set, boost_unit_test_framework is not needed. I.e. under this condition, the |
| 10 |
program can be compiled without -l boost_unit_test_framework. |
| 11 |
|
| 12 |
* Compile: |
| 13 |
|
| 14 |
make |
| 15 |
|
| 16 |
* execute/run the tool: |
| 17 |
|
| 18 |
./utrrnaseq |
| 19 |
|
| 20 |
* Boost Library: |
| 21 |
|
| 22 |
A version of the boost library (e.g. Boost_1_49_0) must be installed or at least downloaded, for Ubuntu e.g. type "sudo apt-get install libboost-all-dev" |
| 23 |
See docs/INSTALL.md (Boost section) for further details, especially for manual installation from sources or installation |
| 24 |
without root rights. |
| 25 |
|
| 26 |
************************************************* |
| 27 |
|
| 28 |
This folder contains the following folders: |
| 29 |
|
| 30 |
* Debug - This folder contains the object and dependency files. |
| 31 |
|
| 32 |
* doc - The file ./doc/utrrnaseq.doxyfile serves as a configuration file for Doxygen. |
| 33 |
The folder ./doc/html and ./doc/latex contain the automatically by Doxygen created files. |
| 34 |
This folder also contains all the source code and data used for my bachelor thesis and my thesis itself. |
| 35 |
|
| 36 |
* evaluation - This folder contains files used for test, training and evaluation purposes. |
| 37 |
|
| 38 |
* for-test-cases - This folder contains files used as input for the test cases in the BOOST_TEST_SUITEs and some for |
| 39 |
comparison purposes. |
| 40 |
|
| 41 |
* input - This folder contains all the used input files and additional data files. |
| 42 |
|
| 43 |
* scripts - This folder contains additional Perl-scripts used for evaluation. |
| 44 |
|
| 45 |
* src - This folder contains all the source code of the tool. |
| 46 |
|
| 47 |
************************************************ |
| 48 |
|
| 49 |
This folder contains the following files: |
| 50 |
|
| 51 |
* output.example - This file serves as an example for the format of the output file. |