]> Devoid-pointer.net GitWeb - libHPCS.git/commitdiff
Update the README file
authorMichal Malý <madcatxster@devoid-pointer.net>
Thu, 11 May 2017 10:58:57 +0000 (12:58 +0200)
committerMichal Malý <madcatxster@devoid-pointer.net>
Thu, 11 May 2017 10:58:57 +0000 (12:58 +0200)
README.md

index 0615e04cbf4519ce55f3b5ede162aee051a5cb30..bd2bdcc1331f7e4f546d8e82d8f2f74c29186a77 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ libHPCS
 Introduction
 ---
 
-libHPCS is a simple library that can read electrophoreogram and chromatogram data written by HP (Agilent) ChemStation software. Information about the format of the data files were obtained through reverse-engineering. Author of the library puts no guarantee on the correctness of the data or on the ability of libHPCS to read a specific datafile. It is strongly recommended that users of the library verify correctness of the data returned by the library.
+libHPCS is a simple library that can read electrophoregram and chromatogram data written by HP (Agilent) ChemStation software. Information about the format of the data files were obtained strictly through reverse-engineering. Author of the library puts no guarantee on the correctness of the data or on the ability of libHPCS to read a specific data file. It is strongly recommended that the users of the library verify the correctness of the data returned by the library.
 
 Build
 ---
@@ -17,6 +17,7 @@ libHPCS can be built on Linux systems with [CMake](https://cmake.org) build syst
        cd build
        cmake .. -DCMAKE_BUILD_TYPE=Release
        make
+       make install
 
 libHPCS makes use of the [ICU library](http://site.icu-project.org). ICU 52 or newer (including its development packages, if shipped separately) has to be installed in order to build libHPCS.
 
@@ -26,12 +27,12 @@ libHPCS should be buildable on other UNIX systems as well, either manually or th
 
 #### Windows
 
-Project for Microsoft Visual Studio 2013 is provided; see the **VS2013** subdirectory. libHPCS uses Windows' own facilities to handle character encodings, ICU library is not required.
+Project for Microsoft Visual Studio 2013 is provided; see the **VS2013** subdirectory. libHPCS uses Windows' own facilities to handle character encodings, the ICU library is not required.
 
 Usage
 ---
 
-Simple testing tool `test_tool.c` is provided to introduce the library's API. Publicly exported functions and data structures are defined in `include/libHPCS.h` header file. Please note that libHPCS allocates memory for it's data structures by itself. The provided `free()` functions shall be used to reclaim the memory.
+Simple testing tool `test_tool.c` is provided to demonstrate the library's API and display sample output. The test tool is not built by default; supply `-DBUILD_TEST_TOOL=ON` parameter to CMake if you wish to build the tool along with the library. Publicly exported functions and data structures are defined in `libHPCS.h` header file. Please note that libHPCS allocates memory for its data structures by itself. The provided `hpcs_free_*()` functions shall be used to reclaim the memory.
 
 Reporting bugs and incompatibilities
 ---