Comments (7)
Here are some tutorials in other C++ projects that I think are well-structured:
- https://github.com/catchorg/Catch2/blob/master/docs/Readme.md
- https://sinusoid.es/immer/#contents
- https://github.com/emil-e/rapidcheck/blob/master/doc/user_guide.md
- (https://github.com/emil-e/rapidcheck/blob/master/README.md is good as well)
Extra pointers appreciated!
from approvaltests.cpp.
In the Introduction, I would add in a “What is Approval Testing” section first, just so people know what kind of thing they’re looking at.
from approvaltests.cpp.
In the Introduction, I would add in a “What is Approval Testing” section first, just so people know what kind of thing they’re looking at.
Done! Thanks @barneydellar
from approvaltests.cpp.
Maybe add something like “Requirements and Dependencies”
from approvaltests.cpp.
A nice trick that the Catch2 docs use is to put a top target in each page, and then link like this:
https://github.com/catchorg/Catch2/blob/master/docs/tutorial.md#top
This hides all the github boilerplate UI at the top of the page, so all the reader sees is the documentation, which makes it look a bit more professional.
from approvaltests.cpp.
Once the structure settles down, add a Contents section at the start of each page - see the Catch2 tutorial link above.
from approvaltests.cpp.
I'm going to declare the structure of the User Guide as good enough, and crack on with filling in the blanks. So marking this as closed.
from approvaltests.cpp.
Related Issues (20)
- Add a copyright statement to the released single header HOT 1
- GitHub Actions: Don't run scheduled tasks on forked repos
- Using kdiff3 as diff tool, user has to specify name of output file after merge
- cygwin CI build hangs for 6 hours then fails HOT 5
- warning C4459 in MSVC with /W4 HOT 1
- Does not compile with clang13 due to -Werror/-Wdeprecated-copy-with-dtor HOT 2
- Ninja + Catch2 + mingw64
- useApprovalsSubdirectory() doesn't create the output directory in the expected location HOT 3
- "Unable to create directory" - unable to run test build with mingw provided by qt-installer HOT 5
- with CppUTest: `ApprovalMismatchException` suppresses other tests output HOT 4
- add `code -d {Received} {Approved}` to Reporters list
- Catch2 integration does not handle Generators inside sections HOT 1
- Catch2 v3 integration HOT 5
- Bug with {fmt} integration HOT 2
- CLion reporter does not open correctly if CLion is already open
- In-lining test output (as opposed to saving in files) HOT 4
- Support for catch2 v3.x.x HOT 2
- Diffing tool is never prompted to open HOT 13
- Impossible to use UNC filename in TemplatedCustomNamer [`removeRedundantDirectorySeparators()` breaks use of UNC paths, which contain `\\`] HOT 5
- _mkdir fails when asked to create more than one directory HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from approvaltests.cpp.