From c4ab6ca4368d45fe7a68a9138f7467408db9f414 Mon Sep 17 00:00:00 2001 From: niftynei Date: Thu, 28 May 2020 21:29:09 -0500 Subject: [PATCH] readme: add easier to skim notes for running the tests + formatter Make it easier to skim the docs to find relevant notes for running the formatter and test suite --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 75f230bbb..339bbd617 100644 --- a/README.md +++ b/README.md @@ -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: