Add examples shroud user projects?
Nobody has claimed this yet.
- Dominant language
- Fortran
- Stars
- 97
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
It would be helpful to potential users if shroud had two simple standalone example projects (e.g. with only one or two functions):
* A cmake (or blt) C++ project that generates Fortran and Python bindings
* A make-based C++ project that generates Fortran and Python bindings
These could help users understand how to set up shroud within their project.
They could be placed in a new top-level directory, e.g. ``/examples``,
described in the user docs and CI tested (e.g. through travis).
Contributor guide
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
Start by reviewing the existing user documentation and Travis CI configuration, then inspect how Shroud projects are currently built. The work is complete when standalone CMake or BLT and make-based C++ examples generate Fortran and Python bindings, are documented for users, and are exercised by CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp, fortran, python
- Domain
- build-system, documentation, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100