From c40943c1fb007c4d8d3c6292e4008857d47b1a95 Mon Sep 17 00:00:00 2001
From: minhtrannhat <minh@minhtrannhat.com>
Date: Sat, 1 Mar 2025 02:53:37 -0500
Subject: [PATCH] feat(misc): added README.md

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a12591
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# OS161 Learning
+
+## Setup
+
+- Follow instructions from UBC University: <https://people.ece.ubc.ca/~os161/os161-site/install-docker.html>
+- Get their docker image and build the container
+- Go here to get the OS161 base source tarball <http://www.os161.org/download/>
+- Do your magic (gunzip, tar -xvf) and make sure the folder is named `src`
+- Next your need a config file, a sample config file (provided by UBC) can be obtained by <https://people.ece.ubc.ca/~os161/os161-site/install.html>
+- Then we run the kernel with the help of the `sys161` simulator:
+
+        cd ~/os161/root
+        sys161 kernel
+
+## The pieces
+
+- OS/161 Kernel source tree
+  - The kernel sources for OS/161 is in the `kern` subdirectory, which has its own configuration script.
+  - The `conf.kern` file determines what source files get included in our kernel build so we might have to modify the file later on.