Updated readme.

This commit is contained in:
Steffen Schuemann 2020-12-26 13:54:57 +01:00
parent 1edf4a3339
commit ff56073075

View File

@ -66,6 +66,9 @@ where full C++17 is available, it doesn't try to be a "better"
`std::filesystem`, just a drop-in if you can't use it (with the exception `std::filesystem`, just a drop-in if you can't use it (with the exception
of the UTF-8 preference on Windows). of the UTF-8 preference on Windows).
This implementation is following the ["UTF-8 Everywhere" philosophy](https://utf8everywhere.org/) in that all
`std::string` instances will be interpreted the same as `std::u8string` encoding
wise and as being in UTF-8. The `std::u16string` will be seen as UTF-16 and
Unit tests are currently run with: Unit tests are currently run with:
@ -379,6 +382,16 @@ ghc::filesystem under C++17.
### Differences in API ### Differences in API
To not depend on any external third party libraries and still stay portable and
compact, this implementation is following the ["UTF-8 Everywhere" philosophy](https://utf8everywhere.org/) in that all
`std::string` instances will be interpreted the same as `std::u8string` encoding
wise and as being in UTF-8. The `std::u16string` will be seen as UTF-16 and `std::u32string` will be
seen as unicode codepoints. Depending on the size of `std::wstring` characters, it will handle
`std::wstring` as being UTF-16 (e.g. Windows) or `char32_t` unicode codepoints
(currently all other platforms).
#### Differences of Specific Interfaces
```cpp ```cpp
filesystem::path::string_type filesystem::path::string_type
filesystem::path::value_type filesystem::path::value_type