Skip to content

Commit

Permalink
contributing (#25)
Browse files Browse the repository at this point in the history
Co-authored-by: Jonah Maxwell Miller <[email protected]>
  • Loading branch information
Yurlungur and jonahm-LANL authored Mar 17, 2022
1 parent b2ebb7e commit 2607fd8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Spiner](https://en.wikipedia.org/wiki/Brent_Spiner). For full documentation, see

`Spiner` is self-contained. Simply clone it as
```bash
git clone --recursive [email protected]:jonahm/spiner.git
git clone [email protected]:jonahm/spiner.git
```
To build and run unit tests,
```bash
Expand Down Expand Up @@ -133,12 +133,20 @@ slice shown). Convergence is second-order, as expected.

![convergence plot](figs/convergence.png)

## Contributing

If you use Spiner and need help, submit an issue to the Spiner
repository. If you'd like to contribute, just fork and submit a pull
request. There's a check list in the PR template, and one of the main
Spiner developers will review your PR.

## Contributors

`Spiner` was primarily developed by Jonah Miller in collaboration with
- Chad Meyer
- Daniel Holladay
- Josh Dolence
- Sriram Swaminarayan

Continuous integration and build system support has been provided by
- Jonah Miller
Expand Down
5 changes: 5 additions & 0 deletions doc/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ slice shown) on a GPU, with second-order convergence:
See below for details of how to use spiner in your project and how to
develop for it.

If you use Spiner and need help, submit an issue to the Spiner
repository. If you'd like to contribute, just fork and submit a pull
request. There's a check list in the PR template, and one of the main
Spiner developers will review your PR.

Spiner also relies on `Ports of Call`_ as a simple performance
portability layer. Ports of Call is included as a submodule, and
automatically integrated into the build system.
Expand Down

0 comments on commit 2607fd8

Please sign in to comment.