Add Python plus C++ demo example documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 14.4k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
When one wants to use arguments in a C++ demo, the best variant is to use Python and then call to C++.
We should document in doc/code/testing.md with a very simple example how this can be done.
A practical existing example is in openage/renderer/, which calls to libopenage/renderer/tests.cpp::renderer_demo.
So in short: update the testing documentation how to do a C++ demo with Python argparsing.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read doc/code/testing.md and inspect the existing example in openage/renderer/, including libopenage/renderer/tests.cpp::renderer_demo. Document a simple example showing how Python argument parsing can be used with a C++ demo. Done means the testing documentation explains this workflow with a practical example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100