Skip to content

README.md

Latest commit

 

History

History
66 lines (46 loc) · 1.55 KB

README.md

File metadata and controls

66 lines (46 loc) · 1.55 KB
Raw

commandkit logo

commandkit

one sentence about what it does..

Usage • Building • Project Structure • License

About

What this project is, and what it is not.

Usage

#include <commandkit/commandkit.hpp>

auto text = commandkit::greeting();

Building

Requires CMake 3.21+ and a C++17 compiler. On Windows, open the folder in Visual Studio 2022 and pick a configuration from the dropdown, or from a terminal (after loading the matching vcvars64.bat/vcvars32.bat):

cmake --preset x64-Debug
cmake --build --preset x64-Debug
ctest --preset x64-Debug

Presets: x64/x86 combined with Debug, Release, RelWithDebInfo, MinSizeRel, ReleaseNoOptWithDeb (no optimization, debug info, NDEBUG on) and DebugASan (AddressSanitizer). Output goes to build/<preset>/.

Project Structure

include/commandkit/   public headers
src/                  implementation
examples/             small programs that use the library
tests/                test runner (registered with ctest)
docs/                 documentation and the logo
CMakePresets.json     build configurations

License

The source code is licensed under the AGPL v3 License.

Made with ❤️