Skip to content

readme: add easier to skim notes for running the tests + formatter #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
niftynei wants to merge 1 commit into from
Closed

readme: add easier to skim notes for running the tests + formatter #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,17 @@ should format your changes using [uncrustify](https://github.com/uncrustify/uncr
version 0.60 or later. The script `./tools/uncrustify` will reformat all C
sources in the library as needed, with the currently chosen uncrustify options.

E.g.

./tools/uncrustify src/transaction.c

You should also make sure the existing tests pass and if possible write tests
covering any new functionality, following the existing style.

You can run the tests via:

make check

## Generating a coverage report

To generate an HTML coverage report, install `lcov` and use:
Expand Down