standardpaths/README.md

1.6 KiB

standardpaths

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.) and taking advantage of the std::filesystem API available since the C++17.

Installation

Add this repo to your project's repo as a sub-module:

git submodule add https://gitlab.com/0x20.eu/standardpaths
git submodule update --init --recursive

Usage

  • Include "standardpaths.hpp".
  • 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.

Support

For questions, suggestions, or bug reports etc. please use the issue tracker.

Contributing

Feel free to submit a merge request through Gitlab.

Authors and Acknowledgments

Created by Chistopher Arndt. Inspired by GLib's gutils.c and Qt's QtStandardPaths.

License

MIT license

Project status

This project is in early alpha-stage.