Merge pull request #18 from kinow/prepare-07

Prepare 0.7

.github/workflows/ci.yml

@@ -18,7 +18,6 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        java: [ 8, 11, 17 ]
         experimental: [false]
     steps:
       - uses: actions/checkout@v3.3.0

CHANGES.md

@@ -1,8 +1,13 @@
-## 0.7 (??/??/2023)
-
-- Added extensions to project files (e.g. LICENSE.md), preferring Markdown where possible (for GitHub)
-- Updated Changelog to include existing releases
-- Added CMake configuration
+## 0.7 (26/02/2023)
+
+- Added extensions to project files (e.g. LICENSE.md), preferring Markdown where possible (for GitHub).
+- Updated Changelog to include existing releases.
+- Added initial CMake configuration (probably needs some more working - pull requests are welcome!).
+- Added `CONTRIBUTING.md`.
+- Made all GitHub documentation files Markdown.
+- Renamed `samples` to `examples`
+- Added CI with GitHub Actions (builds main library/interface and also an example executable).
+- Added more documentation (including definitions/directives).
 
 ## 0.6 (07/05/2016)
 

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing
+
+The GTest TAP Listener project is an open source project, and we welcome contributions of all kinds:
+tests, improving CMake configuration, typos, documentation, bug reports and reviews of other contributions.

README.md

@@ -1,21 +1,47 @@
-GTest TAP Listener 0.4
-============================
+# GTest TAP Listener
 
-https://github.com/kinow/gtest-tap-listener
-https://github.com/google/googletest
-https://tupilabs.com/tap4j/
+[![CI](https://github.com/kinow/gtest-tap-listener/actions/workflows/ci.yml/badge.svg)](https://github.com/kinow/gtest-tap-listener/actions/workflows/ci.yml)
 
-Overview
---------
+## Overview
 
 This is a small contribution to Google Test. Oliver and I were working on an 
 issue in Jenkins plug-in when he told me about Google Test. As this plug-in 
 relies heavily on TAP, we talked about how it looked like a good idea have TAP 
 in GoogleTest.
 
-Although GoogleTest has a XML outputter, it lacks a TAP one. Using its Event 
+Although GoogleTest has an XML writer, it lacks a TAP one. Using its Event 
 Listeners model it was quite easy to implement this first version of this TAP 
 listener.
 
-See the samples directory for code to be used as reference. Feel free to send 
-contributions, pull requests, suggestions or any other feedback to the project.
+See the [`examples`](https://github.com/kinow/gtest-tap-listener/tree/master/examples)
+directory for code to be used as reference.
+
+## Write to `stdout`
+
+By default, the GoogleTest TAP Listener emits TAP to files with names that match the
+test names. If you prefer to have the output written to `stdout`, use the definition
+`GTEST_TAP_PRINT_TO_STDOUT` when compiling your project.
+
+## Changelog
+
+See [`CHANGES.md`](CHANGES.md).
+
+## Contributions
+
+Feel free to send contributions, pull requests, suggestions or any other feedback to the project.
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+## Authors
+
+A list of contributors to this repository can be found in [`CONTRIBUTORS.txt`](CONTRIBUTORS.txt).
+
+## Links
+
+- <https://github.com/kinow/gtest-tap-listener>
+- <https://github.com/google/googletest>
+- <https://tupilabs.com/tap4j/>
+
+## License
+
+Licensed under MIT. See [`LICENSE.txt`](LICENSE.txt).