From 5384e6bc7a1ba87936569324c2d579d77c96f1c1 Mon Sep 17 00:00:00 2001 From: Christopher Arndt Date: Fri, 14 Jul 2023 07:03:11 +0200 Subject: [PATCH] docs: readme improvements Signed-off-by: Christopher Arndt --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 751556d..d8a0d23 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ 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 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 @@ -22,7 +23,7 @@ git submodule update --init --recursive * Add `standardpaths.cpp` to the list of sources. * Compile your project with `-std=c++17 -I./standardpaths`. * Link with `-luuid -lole32` (only needed for Windows targets). -* See `standardpaths.hpp` for API. +* See [standardpaths.hpp](./standardpaths.hpp) for API. ## Support @@ -33,7 +34,7 @@ For questions, suggestions, or bug reports etc. please use the ## Contributing -Feel free to sumit a merge request through Gitlab. +Feel free to submit a merge request through Gitlab. ## Authors and Acknowledgments @@ -52,7 +53,8 @@ MIT license 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 +[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