chris/standardpaths
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: readme improvements

Browse Source 
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
Christopher Arndt 2023-07-14 07:03:11 +02:00
parent 400d62f49d
commit 5384e6bc7a
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -4,7 +4,8 @@
A small C++ library to get the system- and user-specfic paths for loading and A small C++ library to get the system- and user-specfic paths for loading and
storing application data and configuration in a cross-platform and storing application data and configuration in a cross-platform and
platform-appropriate way (e.g. using [XDG] on Linux, [SHGetKnownFolderPath] platform-appropriate way (e.g. using [XDG] on Linux, [SHGetKnownFolderPath]
on Windows, etc.). on Windows, etc.) and taking advantage of the [std::filesystem] API available
since the C++17.
## Installation ## Installation
@ -22,7 +23,7 @@ git submodule update --init --recursive
* Add `standardpaths.cpp` to the list of sources. * Add `standardpaths.cpp` to the list of sources.
* Compile your project with `-std=c++17 -I./standardpaths`. * Compile your project with `-std=c++17 -I./standardpaths`.
* Link with `-luuid -lole32` (only needed for Windows targets). * Link with `-luuid -lole32` (only needed for Windows targets).
* See `standardpaths.hpp` for API. * See [standardpaths.hpp](./standardpaths.hpp) for API.
## Support ## Support
@ -33,7 +34,7 @@ For questions, suggestions, or bug reports etc. please use the
## Contributing ## Contributing
Feel free to sumit a merge request through Gitlab. Feel free to submit a merge request through Gitlab.
## Authors and Acknowledgments ## Authors and Acknowledgments
@ -52,7 +53,8 @@ MIT license
This project is in early alpha-stage. This project is in early alpha-stage.
[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[SHGetKnownFolderPath]: https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath
[gutils.c]: https://gitlab.gnome.org/GNOME/glib/-/blob/5d6c044da45b777970abab2a990208dbeb44794d/glib/gutils.c
[QtStandardPaths]: https://doc.qt.io/qt-6/qml-qt-labs-platform-standardpaths.html [QtStandardPaths]: https://doc.qt.io/qt-6/qml-qt-labs-platform-standardpaths.html
[SHGetKnownFolderPath]: https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath
[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[gutils.c]: https://gitlab.gnome.org/GNOME/glib/-/blob/5d6c044da45b777970abab2a990208dbeb44794d/glib/gutils.c
[std::filesystem]: https://en.cppreference.com/w/cpp/filesystem