Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make README.md compatible with ReText

This commit is contained in:
Martchus 2017-06-24 23:53:51 +02:00
parent 5656b4c203
commit db60e39630
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -3,30 +3,31 @@ Common C++ classes and routines used by my applications such as argument parser,
## Features ## Features
The library utilizes: The library utilizes:
* parsing command-line arguments and providing Bash completion * parsing command-line arguments and providing Bash completion
* dealing with dates and times * dealing with dates and times
* conversion of primitive data types to byte-buffers and vice versa (litte-endian and big-endian) * conversion of primitive data types to byte-buffers and vice versa (litte-endian and big-endian)
* common string conversions/operations, eg. * common string conversions/operations, eg.
- character set conversion via iconv - character set conversion via iconv
- split, join, find and replace - split, join, find and replace
- conversion from number to string and vice verca - conversion from number to string and vice verca
- encoding/decoding base-64 - encoding/decoding base-64
- building string without multiple heap allocations (string builder) - building string without multiple heap allocations (string builder)
* 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
- reading/writing INI files - reading/writing INI files
- reading bitwise - reading bitwise
* building with CMake by providing some modules and templates * building with CMake by providing some modules and templates
## Build instructions ## Build instructions
### Requirements ### Requirements
#### Build-only dependencies #### Build-only dependencies
* C++ compiler supporting C++14, tested with * C++ compiler supporting C++14, tested with
- GNU g++ - Clang
- Clang - regular GNU g++
- mingw-w64 g++ - mingw-w64 g++
- Cygwin g++ - Cygwin g++
* CMake (at least 3.3.0) * CMake (at least 3.3.0)
* cppunit for unit tests (optional) * cppunit for unit tests (optional)
* Doxygen for API documentation (optional) * Doxygen for API documentation (optional)