aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Cunningham <cc@localhost>2022-04-05 17:01:17 -0700
committerChristian Cunningham <cc@localhost>2022-04-05 17:01:17 -0700
commit7928a3c92869cc9e74a4ba6a7298c625303719b2 (patch)
tree3421319cce281705ff10a8fa310d3a8f2e1d3b21
parent1cbc64243c3716a476a8d602d4313852a4b05df9 (diff)
Add more assumptions about application layout
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 21f5e79..104db10 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,8 @@ This `main` function, can serve as the initialization function for the RTOS appl
IRQ handles can be initialized with the `irq_subscribe(IRQ_NAME, callback_function, pointer to additional IRQ information)`.
Examples can be found in the provided `usr/main.c`.
+Headers for files in `usr/` are expected in `include/usr/`. They can then be included in source files with `#include <usr/path/to/file.h>`.
+
Currently, if you build Jobbed without modifying anything, it will generate the RTOS core testing suite.
This testing suite outputs the tracing, thread switch, low and high priority thread creation, mutex creation, mutex destruction, mutex locking contention, mutex locking non-contention, mutex unlocking, semaphore waiting, semaphore signalling at zero, semaphore signalling non-zero timings to a 1920x1080 display output.
Currently the graphics driver expects this resolution of display. If you have another resolution, this can be changed in `kernel/graphics/lfb.c` by modifying `SCR_WIDTH` and `SCR_HEIGHT`.