README.md

Documentation — ffm-reference

This folder contains project-wide guides and design notes. Module-specific documentation lives under each module (for example simple-ffm-demo/docs/ and mymodbus/README.md).

Recommended reading order (new to FFM)

1. Start Here: FFM Introduction
2. Build and run the simple demo
3. FFM + jextract guide (demo)
4. Design notes (demo)
5. FFM Fundamentals
6. Advanced FFM examples (structs, callbacks, arenas)
7. Thread safety considerations
8. JDK 25 concurrency notes
9. Hexagonal Architecture + FFM
10. FFM + Vector API
11. mymodbus overview
12. Setting up libmodbus
13. Benchmarking: how to run JMH → report → assessment
14. External references

Quick paths

Just run the demo

• Build and run
• FFM + jextract guide

Just use mymodbus

• mymodbus README
• Setting up libmodbus

Contents by topic

FFM

• Introduction
• Article-style tour
• Fundamentals
• Thread safety
• Vector API complement

Architecture

• Hexagonal Architecture + FFM

Concurrency

• JDK 25 concurrency notes

Modbus

• Setting up libmodbus
• Benchmark results assessment

Project

• External references