From 50c7c30001a4ff7ac98fb3bab274f7b94fe7527c Mon Sep 17 00:00:00 2001 From: Teodor Dutu Date: Mon, 26 Feb 2024 14:39:22 +0200 Subject: [PATCH] Add content description Add a list of all chapters and a short rundown of the types of content to be found in the repo. Signed-off-by: Teodor Dutu --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f4e00e4a..bc8091da 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,26 @@ ## Using the Content -TODO +Content is located in the `chapters/` folder. +It currently consists of 5 chapters: + +- [Memory Layout](chapters/memory-layout/) +- [Introduction to Computer Architecture](content/intro-computer-architecture/) +- [Hardware-Software Interface](chapters/hardware-software-interface) +- [Stack](chapters/stack/) +- [Memory Security](chapters/memory-security/) + +Each chapter has its own folder. +Content for each chapter is split in subfolders according to each topic: +Each topic is further split into different kinds of materials that refer to it. +These may be any collection of the following: + +- `reading/`: content to be assimilated by learners on their own +- `slides/`: content to be aggregated into presentations +- `drills/`: practical exercises for learners +- `media/`: images, videos, audio or auxiliary materials to be imported in text content +- `demos/`: snippets to be presented by educators +- `guides/`: tutorials for learners with guided steps towards the solution ## Chapter Contents