Skip to content

Commit ae20302

Browse files
Update README.md
1 parent 895d071 commit ae20302

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,6 @@ Conan can install packages directly from a GitHub repository if it contains a va
7171
```bash
7272
# Install from GitHub (replace branch/tag if needed)
7373
conan install git+https://github.com/fossillogic/fossil-test.git#v1.2.7 --name pizza_test --build=missing
74-
75-
# Build your project
76-
# CMake example:
77-
cmake -S . -B build
78-
cmake --build build
79-
80-
# Meson example:
81-
meson setup builddir
82-
meson compile -C builddir
83-
meson test -C builddir
8474
```
8575

8676
**Note**: For the best experience, always use the latest release of Pizza Test. Visit the [Pizza Test Releases](https://github.com/pizzalogic/pizza-test/releases) page for the latest versions.
@@ -117,6 +107,25 @@ To configure the build system with testing enabled, use the following command:
117107
meson setup builddir -Dwith_test=enabled
118108
```
119109

110+
#### Tests Double as Samples
111+
112+
The `fossil-test` project is designed so that **test cases serve two purposes**:
113+
114+
-**Unit Tests** – validate the framework’s correctness.
115+
- 📖 **Usage Samples** – demonstrate how to write tests with `fossil-test`.
116+
117+
This approach keeps the codebase compact and avoids redundant “hello world” style examples.
118+
Instead, the same code that proves correctness also teaches usage.
119+
120+
This mirrors the **Meson build system** itself, which tests its own functionality by using Meson to build Meson.
121+
In the same way, `fossil-test` validates itself by demonstrating real-world usage in its own tests.
122+
123+
```bash
124+
meson test -C builddir -v
125+
```
126+
127+
Running the test suite gives you both verification and practical examples you can learn from.
128+
120129
---
121130

122131
## ***Contributing and Support***

0 commit comments

Comments
 (0)