1- Project Notes
1+ # Project Notes
22
33DO NOT modify project settings for each configuration and/or platform
44on a per-project basis. Use property sheets to set shared configuration
55properties. The rule of thumb - if you set same value for the same
66property in more than one configuration or platform, you did it wrong.
77
8- libmaxminddb.props
8+ ## libmaxminddb.props
99
1010This is the base property sheet for libMaxMindDB project. It contains
1111settings that are shared between all configurations, such as compiler
@@ -15,21 +15,21 @@ In order to minimize the number of property sheet files, this propery
1515sheet also contains settings for Win32 and Debug configurations, which
1616are overridden by the x64 and Release property sheets described below.
1717
18- libmaxminddb-release.props
18+ ## libmaxminddb-release.props
1919
2020This property sheet contains all Release settings and is shared between
2121Win32 and x64 release builds. It must be located higher than the base
2222property sheet in the property Manager window for each configuration
2323where it's used (i.e. Release|Win32 and Release|x64).
2424
25- libmaxminddb-x64.props
25+ ## libmaxminddb-x64.props
2626
2727This property sheet contains all x64 settings and is shared between all
2828Debug and Release x64 configurations. It must be located higher than the
2929base property sheet in the property Manager window for each configuration
3030where it's used (i.e. Debug|x64 and Release|x64).
3131
32- Adding More Projects
32+ ## Adding More Projects
3333
3434If you want to add more projects into this solution, follow the same logic
3535and create their own property sheets. Do not use libmaxminddb property
@@ -50,3 +50,10 @@ each library file's property to assign them to the proper build confguration.
5050Unused libraries will be shown with a traffic stop sign in each configuration.
5151If you have a lot of projects, it might be easier to do this by editing .vcxproj
5252and .vcxproj.filters in a text editor.
53+
54+ # Tests
55+
56+ To use the tests, you must download the ` libtap ` and ` maxmind-db ` submodules.
57+ This can be done by running ` git submodule update --init --recursive ` from
58+ the Git checkout. Each test source file has a separate project. Once compiled,
59+ the tests must be run from the base directory of the checkout.
0 commit comments