Update README.md
This commit is contained in:
parent
ca8432c5ec
commit
1deb244fee
19
README.md
19
README.md
|
@ -1,21 +1,20 @@
|
||||||
# c++utilities
|
# C++ utilities
|
||||||
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities.
|
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
The library utilizes:
|
The library utilizes:
|
||||||
* parsing command-line arguments
|
* parsing command-line arguments
|
||||||
* dealing with chronology (DateTime, TimeSpan)
|
* dealing with dates and times
|
||||||
* conversion of primitive data types to byte-buffers and vice versa, supporting
|
* conversion of primitive data types to byte-buffers and vice versa (litte-endian and big-endian)
|
||||||
litte-endian and big-endian
|
|
||||||
* common string conversions/operations, eg.
|
* common string conversions/operations, eg.
|
||||||
- split, join, findAndReplace
|
- split, join, find and replace
|
||||||
- numberToString, stringToNumber
|
- conversion from number to string and vice verca
|
||||||
- encodeBase64, decodeBase64
|
- encoding/decoding base-64
|
||||||
* IO
|
* IO
|
||||||
- reading/writing primitive data types of various sizes (little-endian and big-endian)
|
- reading/writing primitive data types of various sizes (little-endian and big-endian)
|
||||||
- reading/writing terminated strings and size-prefixed strings
|
- reading/writing terminated strings and size-prefixed strings
|
||||||
- bitwise reading
|
- reading/writing INI files
|
||||||
- parsing INI files
|
- reading bitwise
|
||||||
* building with CMake by providing some modules and templates
|
* building with CMake by providing some modules and templates
|
||||||
|
|
||||||
## Build instructions
|
## Build instructions
|
||||||
|
@ -24,6 +23,7 @@ The library utilizes:
|
||||||
* C++ compiler supporting C++11 (I've tested GNU g++, Clang and mingw-w64 yet.)
|
* C++ compiler supporting C++11 (I've tested GNU g++, Clang and mingw-w64 yet.)
|
||||||
* CMake (I've only tested 3.5.1 so far.)
|
* CMake (I've only tested 3.5.1 so far.)
|
||||||
* cppunit for unit tests (optional)
|
* cppunit for unit tests (optional)
|
||||||
|
* Doxygen for API documentation (optional)
|
||||||
|
|
||||||
#### Runtime dependencies
|
#### Runtime dependencies
|
||||||
* The c++utilities library itself only needs the C/C++ standard library.
|
* The c++utilities library itself only needs the C/C++ standard library.
|
||||||
|
@ -36,6 +36,7 @@ cd "path/to/build/directory"
|
||||||
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/projectdirectory"
|
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/projectdirectory"
|
||||||
make
|
make
|
||||||
make check # build and run unit tests (optional)
|
make check # build and run unit tests (optional)
|
||||||
|
make c++utilities_apidoc # build API documentation (optional)
|
||||||
make DESTDIR="/temporary/install/location" install
|
make DESTDIR="/temporary/install/location" install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue