Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/feature/sundials-codes-addons' i…
Browse files Browse the repository at this point in the history
…nto feature/sundials-codes-addons
  • Loading branch information
balos1 committed Apr 16, 2024
2 parents 297580f + f672745 commit 77f6afb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ By making a contribution to this project, I certify that:
```

The DCO lets us know that you are entitled to contribute this code to
[SUNDIALS] and that you are willing to have it used in distributions and
SUNDIALS and that you are willing to have it used in distributions and
derivative works.

By including the DCO signature, you are stating that one or
Expand Down Expand Up @@ -110,9 +110,9 @@ and they **are not maintained by the SUNDIALS team**.

To create a SUNDIALS addon and use it there are a few things you need to do:

1. In your addon project, ensure that you have a `CMakeLists.txt` that uses
1. In your addon project, ensure that you have a `CMakeLists.txt` that uses the
`sundials_add_library` CMake macro to create the library target. The best thing to do is simply
copy from, or refer to, a CMakeLists.txt in the SUNDIALS `src` directory.
copy from, or refer to, a `CMakeLists.txt` in the SUNDIALS `src` directory.
2. Follow the steps in the `README.md` file in the `external/` directory in the root of the SUNDIALS
source code.

Expand Down
2 changes: 1 addition & 1 deletion doc/shared/sundials/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2209,5 +2209,5 @@ To build with SUNDIALS addons,
1. Clone/copy the addon(s) into ``<sundials root>/external/``
2. Copy the ``sundials-addon-example`` block in the ``<sundials root>/external/CMakeLists.txt``,
paste it below the example block, and modify the path listed for your own external addon(s).
3. When building SUNDIALS, set the CMake option :cmakeop:`SUNDIALS_ENABLE_EXTERNAL_ADDONS` to ON
3. When building SUNDIALS, set the CMake option :cmakeop:`SUNDIALS_ENABLE_EXTERNAL_ADDONS` to `ON`
4. Build SUNDIALS as usual.
8 changes: 4 additions & 4 deletions doc/superbuild/source/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ off line in the commit message:
Replacing Jane Doe’s details with your name and email address.

If you've set `user.name` and `user.email` in your Git configuration, you can
If you've set ``user.name`` and ``user.email`` in your Git configuration, you can
automatically add a sign off line at the end of the commit message by using the
`-s` option (e.g., `git commit -s`).
``-s`` option (e.g., ``git commit -s``).


Contributions via SUNDIALS Addons
Expand All @@ -138,9 +138,9 @@ Creating an addon

To create a SUNDIALS addon and use it there are a few things you need to do:

1. In your addon project, ensure that you have a ``CMakeLists.txt`` that uses
1. In your addon project, ensure that you have a ``CMakeLists.txt`` that uses the
``sundials_add_library`` CMake macro to create the library target. The best thing to do is simply
copy from, or refer to, a CMakeLists.txt in the SUNDIALS ``src`` directory.
copy from, or refer to, a ``CMakeLists.txt`` in the SUNDIALS ``src`` directory.
2. Follow the steps in the ``README.md`` file in the ``external/`` directory in the root of the SUNDIALS
source code.

Expand Down

0 comments on commit 77f6afb

Please sign in to comment.