Skip to content

Commit

Permalink
readme updates and test name
Browse files Browse the repository at this point in the history
  • Loading branch information
nate-sime committed Jun 9, 2023
1 parent b9dc668 commit 34385ef
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/run_tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run febug tests
name: febug unit tests

on:
pull_request:
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ de**bug**ing. The paradigm here is to check code written for use with
erroneous or undesireable results as a consequence of numerical scheme
errors rather than syntax errors.

`febug` is developed and tested against the nightly build
`dolfinx/dolfinx:nightly`.

![unit tests badge](https://github.com/nate-sime/febug/actions/workflows/run_tests.yml/badge.svg
)

## Usage

You can import `febug` and call the library functions to check your code
Expand Down

0 comments on commit 34385ef

Please sign in to comment.