Skip to content
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

Jump to bottom

Improve README.md #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README.md #24

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
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Seatest
# Seatest

A simple unit testing framework for C based on the xUnit style of unit testing. Ideal for Test Driven Development ( TDD ). Designed to be portable.

Expand Down Expand Up @@ -108,18 +108,17 @@ Note, this section is currently getting built up and might seem a bit incomplete

1. Download the source code

2) include "seatest.c" and "seatest.h" in your project, make sure the .h is in a directory your compiler will find when including headers.
2. include "seatest.c" and "seatest.h" in your project, make sure the .h is in a directory your compiler will find when including headers.

3) create a function called something like "alltests" which will combine all your test suites together
3. create a function called something like "alltests" which will combine all your test suites together

4) In your main create the test runner
4. In your main create the test runner

5) Create a test suite
5. Create a test suite

6) Create tests

7) Run
## Abort test on first test failure
Normally Seatest will run all asserts in a test no matter whether they pass or fail. If you want the test to abort on the first failure then set the #define ABORT_TEST_IF_ASSERT_FAIL.
6. Create tests

7. Run

## Abort test on first test failure
Normally Seatest will run all asserts in a test no matter whether they pass or fail. If you want the test to abort on the first failure then set the `#define ABORT_TEST_IF_ASSERT_FAIL`.