doc
This commit is contained in:
parent
952b94971f
commit
db63cf776e
@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8
|
||||
# identify the project. Note that if you do not use Doxywizard you need
|
||||
# to put quotes around the project name if it contains spaces.
|
||||
|
||||
PROJECT_NAME = "Concordia Library"
|
||||
PROJECT_NAME = "Concordia"
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
||||
# This could be handy for archiving the generated documentation or
|
||||
|
||||
4
TODO.txt
4
TODO.txt
@ -1,6 +1,8 @@
|
||||
---------------------------- Developer's private notes -----------------------------
|
||||
---------------------------- Developer's private notes (language may vary, bo tak czasem wygodniej) -----------------------------
|
||||
|
||||
- document the code
|
||||
- prepare website (home, downloads, documentation, tutorial, issues, sourceforge page, about author)
|
||||
- copyright libdivsufsort i psi-toolkit (in documentation)
|
||||
IN PROGRESS - concordia search zwraca pozycje tokenów z hash'a. Jak to odnieść do examples w korpusie?
|
||||
- testy zużycia pamięci
|
||||
- Prawdopodobnie długość example w markers będzie potrzebna tylko anubisowi (który, jak się okazuje, jest wolny). Pomyśleć, do czego można wykorzystać markery, bo ich idea wydaje się niezła.
|
||||
|
||||
@ -1,61 +0,0 @@
|
||||
/** \page compilation Concordia Installation & Build Manual
|
||||
|
||||
This file describes how to compile, build
|
||||
and install Concordia library.
|
||||
|
||||
\section compilation1 Requirements
|
||||
|
||||
- cmake
|
||||
- Boost library
|
||||
- Log4cpp
|
||||
- libstemmer (Snowball stemming library)
|
||||
- (optional) Doxygen
|
||||
|
||||
\subsection compilation1_1 Boost Ubuntu installation
|
||||
|
||||
sudo apt-get install libboost-dev libboost-serialization-dev libboost-test-dev libboost-filesystem-dev libboost-system-de libboost-program-options-dev libboost-iostreams-dev
|
||||
|
||||
\subsection compilation1_2 Log4cpp Ubuntu installation
|
||||
|
||||
sudo apt-get install liblog4cpp5-dev
|
||||
|
||||
\subsection compilation1_3 Libconfig Ubuntu installation
|
||||
|
||||
sudo apt-get install libconfig++-dev
|
||||
sudo apt-get install libconfig-dev
|
||||
|
||||
\subsection compilation1_4 Libstemmer Ubuntu installation
|
||||
|
||||
sudo apt-get install libstemmer-dev
|
||||
|
||||
\subsection compilation1_5 Perl-compatible regular expressions (PCRE) Ubuntu installation
|
||||
|
||||
sudo apt-get install libpcre3-dev
|
||||
|
||||
\subsection compilation1_6 Doxygen Ubuntu installation
|
||||
|
||||
sudo apt-get install doxygen
|
||||
|
||||
\section compilation2 Build & installation procedure
|
||||
|
||||
mkdir build<br/>
|
||||
cd build<br/>
|
||||
../cmake.sh<br/>
|
||||
make<br/>
|
||||
make test<br/>
|
||||
make install
|
||||
|
||||
\section compilation3 Documentation
|
||||
|
||||
If Doxygen is available, a successful compilation generates documentation data in three
|
||||
formats in the build/doc directory.
|
||||
|
||||
The man files in doc/man will be installed during installation. Open doc/html/index.html for
|
||||
a HTML version of the same documentation. The latex directory contains uncompiled latex
|
||||
files. To generate a single pdf file run
|
||||
|
||||
cd doc/latex
|
||||
make
|
||||
|
||||
This should generate a single file called refman.pdf in the same directory.
|
||||
*/
|
||||
@ -1,12 +0,0 @@
|
||||
/** \mainpage Introduction
|
||||
|
||||
\section main_1 Concordia - Tool for concordance search in CAT
|
||||
|
||||
|
||||
\section main_2 Overview
|
||||
|
||||
- \subpage compilation This chapter contains instructions to compile, install and run Concordia.
|
||||
- \subpage running The methods of making use of the Concordia library are described in this chapter.
|
||||
- \subpage technical In this chapter technical information about unit tests, project resources and code style is provided.
|
||||
|
||||
*/
|
||||
@ -1,32 +0,0 @@
|
||||
/** \page running Running the Concordia library
|
||||
|
||||
\section running1 Programmatical use of the library
|
||||
|
||||
The main access point to the functionalities of the library is the Concordia class. An example programmatical use of the class is shown below:
|
||||
|
||||
\verbatim
|
||||
snippet
|
||||
\endverbatim
|
||||
|
||||
\section running2 The concordia-console program
|
||||
|
||||
|
||||
After successful build of the project (see \ref compilation2) the concordia-console program is available in the folder build/concordia-console.
|
||||
|
||||
\subsection running2_1 concordia-console options
|
||||
|
||||
The full list of program options is given below:
|
||||
|
||||
\verbatim
|
||||
-h [ --help ] Display this message
|
||||
-c [ --config ] arg Concordia configuration file (required)
|
||||
\endverbatim
|
||||
|
||||
\subsection running2_2 concordia-console example run
|
||||
|
||||
\subsection running2_3 concordia-console output format
|
||||
|
||||
|
||||
\section running3 The Concordia configuration
|
||||
|
||||
Concordia is configured by the means of a configuration file in the libconfig format (http://www.hyperrealm.com/libconfig/).
|
||||
@ -1,28 +0,0 @@
|
||||
/** \page technical Project technical information
|
||||
|
||||
\section technical1 Development
|
||||
|
||||
\subsection technical1_1 Code style
|
||||
|
||||
Use: ./run-checkers.sh script to find the most
|
||||
C++ coding errors. The script uses the following
|
||||
external tools:
|
||||
|
||||
- cpplint.py (http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml?showone=cpplint)
|
||||
- cppcheck
|
||||
|
||||
The reports are stored in the XXX-result.txt files (where XXX is the name of the tool)
|
||||
in the current directory.
|
||||
|
||||
\subsection technical1_2 Unit tests
|
||||
|
||||
Unit tests are integrated into makefiles. Unit tests codes are
|
||||
put in the t/ subdirectory for each library.
|
||||
|
||||
In order to run all unit tests just type:
|
||||
|
||||
make test
|
||||
|
||||
You can get detailed test report by running:
|
||||
|
||||
./tests/unit-tests/test_runner
|
||||
@ -1,12 +1,19 @@
|
||||
/** \mainpage Introduction
|
||||
|
||||
\section main_1 Concordia - Tool for concordance search in CAT
|
||||
\section main_1 Concordia
|
||||
### Full-text and concordance searcher for CAT
|
||||
|
||||
|
||||
\section main_2 Overview
|
||||
|
||||
- \subpage compilation This chapter contains instructions to compile, install and run Concordia.
|
||||
- \subpage compilation This chapter contains instructions for compilation and installation of the Concordia library.
|
||||
- \subpage running The methods of making use of the Concordia library are described in this chapter.
|
||||
- \subpage technical In this chapter technical information about unit tests, project resources and code style is provided.
|
||||
|
||||
\section main_3 Acknowledgements
|
||||
|
||||
Concordia makes use of the following Open Source projects:
|
||||
- [libdivsufsort](https://code.google.com/p/libdivsufsort/) - a lightweight suffix-sorting library
|
||||
- [PSI-Toolkit](http://psi-toolkit.amu.edu.pl/") - multi-functional NLP toolkit
|
||||
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user