Go to file

Christopher Arndt 400d62f49d docs: minimal readme Signed-off-by: Christopher Arndt <chris@chrisarndt.de>		2023-07-14 06:54:49 +02:00
cutf@ca60c39e18	Import initial code	2023-07-14 06:30:03 +02:00
.gitignore	Import initial code	2023-07-14 06:30:03 +02:00
.gitlab-ci.yml	Configure SAST in `.gitlab-ci.yml`, creating this file if it does not already exist	2023-07-14 04:25:19 +00:00
.gitmodules	Import initial code	2023-07-14 06:30:03 +02:00
Makefile	Import initial code	2023-07-14 06:30:03 +02:00
README.md	docs: minimal readme	2023-07-14 06:54:49 +02:00
build-win32.sh	Import initial code	2023-07-14 06:30:03 +02:00
build-win64.sh	Import initial code	2023-07-14 06:30:03 +02:00
standardpaths.cpp	Import initial code	2023-07-14 06:30:03 +02:00
standardpaths.hpp	Import initial code	2023-07-14 06:30:03 +02:00
teststandardpaths.cpp	Import initial code	2023-07-14 06:30:03 +02:00
win.env	Import initial code	2023-07-14 06:30:03 +02:00

README.md

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.).

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 sumit 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.