Improve documentation about USE_NATIVE_FILE_BUFFER

This commit is contained in:
Martchus 2017-08-21 01:29:32 +02:00
parent 0f6ac6a7e3
commit 7ab83a55ec
1 changed files with 6 additions and 0 deletions

View File

@ -38,6 +38,12 @@ It also allows to inspect and validate the element structure of MP4 and Matroska
## Text encoding, Unicode support
The library is aware of different text encodings and can convert between different encodings using iconv.
### Windows specific
A workaround to support filenames containing non-ASCII characters (despite the lack of an UTF-8
supporting `std::fstream` under Windows) can be enabled by adding `-DUSE_NATIVE_FILE_BUFFER=ON`
to the CMake arguments **when building `c++utilities`**. It is *not* sufficient to specify this
option only when building `tagparser`.
## Usage
For examples check out the command line interface of [Tag Editor](https://github.com/Martchus/tageditor).
API documentation can be generated using Doxygen with `make tagparser_apidoc`.