aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: 1abbfd20c3259935402b91a874afb84b59b7e7d0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
winapi-common
=============

[![CI](https://github.com/egor-tensin/winapi-common/actions/workflows/ci.yml/badge.svg)](https://github.com/egor-tensin/winapi-common/actions/workflows/ci.yml)

C++ wrappers for various common WinAPI entities I've had to use in various
projects over the years.

Development
-----------

Build using CMake.
Depends on Boost.Test and Python 3 for running the tests.
The project is Windows-only, so building with either MSVC or MinGW-w64 is
required.

There's a Makefile with useful shortcuts to build the project in the build/
directory (defaults to building with MinGW-w64):

    make deps
    make build
    make test

Documentation
-------------

Build & display the documentation using

    make docs

View the online documentation at https://egor-tensin.github.io/winapi-common/.

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt