Skip to content

Commit ad1f812

Browse files
authored
Merge pull request #32 from banditcpp/prepare-v3.0.0
Prepare v3.0.0
2 parents d5f541a + fa9485d commit ad1f812

File tree

3 files changed

+39
-4
lines changed

3 files changed

+39
-4
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,33 @@ As above, but only in debug builds.
483483
Assert that a test behaved as expected.
484484
Throw an exception and let our testing framework deal with the test failure.
485485

486+
## Versioning
487+
488+
Snowhouse uses [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) since
489+
version 3.0.0.
490+
The macros `SNOWHOUSE_MAJOR`, `SNOWHOUSE_MINOR` and `SNOWHOUSE_PATCH` are defined
491+
accordingly and `SNOWHOUSE_VERSION` contains the version string.
492+
Note that in prior versions `SNOWHOUSE_VERSION` was the only defined macro.
493+
494+
## Contributing
495+
496+
The development of Snowhouse takes place on [GitHub](//github.com/banditcpp/snowhouse).
497+
498+
Snowhouse is licensed under the Boost Software License.
499+
See LICENSE_1_0.txt for further information.
500+
501+
By making available code for inclusion into Snowhouse (e.g., by opening a
502+
pull request on GitHub), you guarantee that the code is licensed under the
503+
same license as Snowhouse.
504+
505+
Please make sure to be consistent with the project's coding style.
506+
The `.clang-format` file allows easy checking and implementation of the
507+
coding style.
508+
509+
C++ code should comply to C++98, C++03- and C++11.
510+
Please use `__cplusplus` guards if you want to use language features of
511+
a certain C++ version.
512+
486513
## Responsibilities
487514

488515
Snowhouse was originally developed as part of the [Igloo](//github.com/joakimkarlsson/igloo)
@@ -492,6 +519,3 @@ It has been extracted to be usable in other contexts, for example,
492519

493520
Snowhouse is maintained by [Stephan Beyer](//github.com/sbeyer) since
494521
[October 2016](//twitter.com/JHKarlsson/status/789332548799332352).
495-
496-
Snowhouse is licensed under the Boost Software License.
497-
See LICENSE_1_0.txt for further information.

example/main.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ void StringizeTests();
1717

1818
int main()
1919
{
20+
std::cout << "Spec for Snowhouse " SNOWHOUSE_VERSION << std::endl;
21+
2022
try
2123
{
2224
BasicAssertions();

snowhouse/macros.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@
22
#define SNOWHOUSE_MACROS_H
33
// clang-format off
44

5-
#define SNOWHOUSE_VERSION "2.1.0"
5+
#define SNOWHOUSE_MAJOR 3
6+
#define SNOWHOUSE_MINOR 0
7+
#define SNOWHOUSE_PATCH 0
8+
9+
#define SNOWHOUSE_TOSTRING(x) #x
10+
#define SNOWHOUSE_MACROTOSTRING(x) SNOWHOUSE_TOSTRING(x)
11+
#define SNOWHOUSE_VERSION \
12+
SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_MAJOR) "." \
13+
SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_MINOR) "." \
14+
SNOWHOUSE_MACROTOSTRING(SNOWHOUSE_PATCH)
615

716
#if __cplusplus > 199711L
817
// Visual Studio (including 2013) does not support the noexcept keyword

0 commit comments

Comments
 (0)