Updated project documentation

This commit is contained in:
Nav
2022-05-02 13:19:03 +01:00
parent 886f61f8a8
commit 6e8abaeeb7

View File

@@ -29,8 +29,9 @@ Bloom is a multithreaded event-driven program written in C++. It consists of fou
##### TargetController
The TargetController possesses full control of the connected debug tool and target. Execution of user-space
device drivers takes place here. All interaction with the connected hardware goes through the TargetController.
It exposes an interface to the connected hardware via events. The TargetController runs on a dedicated thread.
See source code in src/TargetController/ for more.
It exposes an interface to the connected hardware via a command-response mechanism. The TargetController runs on a
dedicated thread. See the [TargetController documentation](./src/TargetController/README.md) and source code in
src/TargetController/ for more.
##### DebugServer
The DebugServer exposes an interface to the connected target, for third-party programs such as IDEs. Currently, Bloom
@@ -49,9 +50,6 @@ The SignalHandler is responsible for handling any UNIX signals issued to Bloom.
other threads within Bloom do not accept any UNIX signals.
See source code in src/SignalHandler/ for more.
#### Inter-component communication
The components described above interact with each other using an event-based mechanism. More on this to follow.
---
### Building Bloom