doc: update the README, remove useless docs

Starry-OS · May 2, 2024 · ebd9747 · ebd9747
1 parent c372171
commit ebd9747
Show file tree

Hide file tree

Showing 141 changed files with 29 additions and 26,483 deletions.
diff --git a/README.md b/README.md
@@ -6,4 +6,29 @@ The main repository of Starry-OS, which will assemble all kernel components into
 
 ## Structure
 
-TODO
+![avatar](./doc/figures/Starry.svg)
+
+## Build and run
+
+```sh
+# Run in unikernel architecture
+
+# $ make A=apps/<app_name> ARCH=<arch> run
+
+# The <app_name> is the application stored in the ./apps folder.
+
+# The <arch> can be x86_64, risc64 and aarch64.
+
+$ make A=apps/helloworld ARCH=x86_64 run
+
+# Run in monolithic architecture
+
+# Make the testcases image first
+
+# $ ./build_img.sh <arch>
+
+$ ./build_img.sh x86_64
+
+$ make A=apps/monolithic_userboot ARCH=x86_64 run
+```
+
diff --git a/doc/OS-Train-Repo/REPORT.md b/doc/OS-Train-Repo/REPORT.md
diff --git a/doc/OS-Train-Repo/Week1.md b/doc/OS-Train-Repo/Week1.md