Mark Jansen
77eca4e819
Simplify instructions by not changing directories for the ctest command
2024-09-13 14:45:04 +02:00
Martin Hořeňovský
a209bcfb54
Update build instructions in contributing.md
...
We now show the more modern `-S {source}` instead of the old and
undocumented `-H{source}` CMake flag, and also show the available
presets, instead of individually specifying the different testing
options.
Closes #2593
2023-02-22 20:11:45 +01:00
Martin Hořeňovský
6aa56c70e2
Mention BUILD.bazel in contributing docs for CATCH_CONFIG*
2022-11-12 22:08:23 +01:00
Martin Hořeňovský
066cc51ce6
Document adding new CATCH_CONFIG options to contributing.md
2022-11-09 16:33:47 +01:00
Lars Toenning
f1084fb309
Fix references to license file
...
The license file was renamed with 6a502cc2f5
2022-10-28 11:30:15 +02:00
Martin Hořeňovský
6a422bae0b
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
tocic
dea1a6abd9
Fix typos in docs ( #2514 )
2022-09-09 16:00:39 +02:00
Martin Hořeňovský
48177831ee
Add version placeholder to the example doc in contributing.md
2022-04-25 21:36:03 +02:00
Martin Hořeňovský
ee3bbecf51
Improve include guard docs in contributing.md
2022-04-25 21:33:05 +02:00
Martin Hořeňovský
72f0372664
Add tests for CMake configure toggles passing to Catch2 build
2022-02-20 19:32:30 +01:00
Alan Jowett
cde26de803
Add buildAndTest.cmd for Windows users ( #2338 )
...
* Add buildAndTest.cmd for Windows users
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2021-12-18 23:52:35 +01:00
Martin Hořeňovský
ca8546efc6
Mention C++14 baseline in contributing documentation
2021-08-19 19:16:12 +02:00
Martin Hořeňovský
4113a12c69
Fix Wreserved-identifier for UDLs in Catch2
...
See #578
2021-08-19 19:15:46 +02:00
Martin Hořeňovský
88c27ffaf2
Mention CATCH_MOVE and CATCH_FORWARD in contributing docs
2021-08-16 16:22:21 +02:00
Julien Brianceau
e8cdfdca87
Fix typos in the code base ( #2206 )
...
Note that only documentation and comments are impacted by this change.
2021-04-07 20:43:50 +02:00
Jozef Grajciar
037ddbc75c
Fix introduced in version placeholders
...
Resolves #2082
2021-03-13 10:26:12 +01:00
Clare Macrae
40b9df567f
Add missing cmake option to fix buildAndTest.sh
...
Note that the documentation was updated automatically, by running:
./tools/scripts/updateDocumentSnippets.py
2020-10-28 11:38:06 +01:00
Clare Macrae
c6352c3e1f
Embed the script buildAndTest.sh inside the docs
2020-10-28 11:38:06 +01:00
Martin Hořeňovský
340ff00058
Rewrite contributing docs for v3
2020-10-06 12:36:20 +02:00
Richard Ash
ed9be5a00b
Add notes on compiling the examples.
...
This took me some time to figure out so document for others.
2020-07-22 21:43:53 +02:00
Martin Hořeňovský
91ee07e08c
Moved scripts/ to tools/scripts/
2019-12-06 11:53:31 +01:00
Mertz, Arne
1aa98c76ac
add a note how to run selftests using multiconfig generators
2019-10-17 20:23:51 +02:00
Martin Hořeňovský
de0674c116
Add a template for creating new documentation page
...
Related to #1695
2019-08-02 13:17:22 +02:00
Martin Hořeňovský
3d7282c2bd
Add a section on documentation to contributing.md
...
Related to #1695
2019-08-02 10:58:51 +02:00
Clare Macrae
0c27554af5
Update Contents in docs #1667
2019-07-06 17:25:55 +02:00
Martin Hořeňovský
3978e9653b
Add more documentation on contributing
2019-04-18 16:18:30 +02:00
Martin Hořeňovský
2988e9f6cf
Update contributing.md to reflect current test setup
2019-01-19 13:05:27 +01:00
Lotte Steenbrink
bc02ada4b0
Add build instructions to contributing.md
2019-01-19 13:05:22 +01:00
Martin Moene
6c09b45a20
Let toplevel links to .md files link to .md#top
2017-08-24 19:40:36 +02:00
Martin Moene
e8225052f1
Add html anchor 'top'
2017-08-24 19:40:36 +02:00
Martin Hořeňovský
9382534d59
Added "How to test changes in PR" section to documentation
...
Also linked it from PR template.
Closes #936
2017-06-26 16:54:14 +01:00
Phil Nash
b0de6c938a
Updated docs for contributing
2017-01-10 07:36:06 +00:00
Phil Nash
21f7ef6fdc
Committed to semantic versioning
...
as prompted by #365 , #430 , #447 and a thread on the google group.
- split version bumping out of generateSingleHeader script
- separate scripts for bumping each version component
- "build" number only incremented for "develop" builds
2015-06-29 18:06:15 +01:00
Phil Nash
32186db1b0
Added first cut of docs for configuring Catch
...
- initially just covers new colour config
- also updated all [Home] links in footers to go to local readme
2014-10-21 18:25:57 +01:00
Phil Nash
76edbc104c
Updated “contributing” docs to reflect new develop branch
2014-08-20 19:03:31 +01:00
Phil Nash
d0e7b628b7
Fixed typo
2013-10-18 17:50:22 +01:00
Phil Nash
f4959e7699
First commit of docs for contributors
2013-10-18 07:52:38 +01:00
