Skip to content

Commit 04d2e6f

Browse files
Update README.md
1 parent 70de142 commit 04d2e6f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,25 @@ Example:
6666
meson setup builddir -Dwith_test=enabled
6767
```
6868

69+
### Tests Double as Samples
70+
71+
The project is designed so that **test cases serve two purposes**:
72+
73+
-**Unit Tests** – validate the framework’s correctness.
74+
- 📖 **Usage Samples** – demonstrate how to use these libraries through test cases.
75+
76+
This approach keeps the codebase compact and avoids redundant “hello world” style examples.
77+
Instead, the same code that proves correctness also teaches usage.
78+
79+
This mirrors the **Meson build system** itself, which tests its own functionality by using Meson to test Meson.
80+
In the same way, Fossil Logic validates itself by demonstrating real-world usage in its own tests via Fossil Test.
81+
82+
```bash
83+
meson test -C builddir -v
84+
```
85+
86+
Running the test suite gives you both verification and practical examples you can learn from.
87+
6988
## Contributing and Support
7089

7190
For contributions, issue reporting, or support, please open an issue on the project repository or visit the [Fossil Logic Docs](https://fossillogic.com/docs) for more information. Your feedback and contributions are appreciated.

0 commit comments

Comments
 (0)