Description

AppDirsCPP, written in C++, is a port of AppDirs (python). This project allow to compile as native C++ library without python requirement.

Features

• Everything AppDirs has except for appauthor parameter's 3rd optional value, False, is excluded.
  • See AppDirs's readme file for details.
• Cross-platform support.
• CMake support for ability to use different compilers.
• Unit tests for each function to ensure they are passing the expectation results.

Contribution Guidelines

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Contributing

Main Prerequisites

1. Git
2. CMake
   • Some IDEs already have CMake support, this is optional.

Fetching the code

Run the following command in the command line:
git clone https://github.com/RadWolfie/AppDirsCPP.git

Compiling

1. Open terminal whichever has CMake support.
   i.e. If you don't have CMake installed, open ___ Native Tools Command Prompt for VS 20##.
2. cd to the AppDirsCPP directory.
3. Run these commands to generate compiler projects.
   1. mkdir build & cd build
   2. cmake .. -G ???; replace ??? to your perferred compiler/IDE from CMake Generator documentation.
4. Open your solution/project(s) from preferred compiler/IDE.
5. Start building project(s).
6. Run tests to ensure your new code has not break the expected results. (RECOMMENDED)

Research References

• AppDirs project
• $XDG_ prefix usages
• Online ECMAScript regex inspection

Credits

• 2010 ActiveState Software Inc.
  • and AppDirs contributors.
• AppDirsCPP contributors