aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarvin Borner2020-08-27 22:47:05 +0200
committerMarvin Borner2020-08-27 22:47:05 +0200
commitb9e24d834ca1a979a0ae433646252d339ef5a81b (patch)
tree56ee7f86134d77c743fc2cb15de425925ca929bd /README.md
parent834ab9e2771b631c46d34fa906b4e2448f9192ca (diff)
Updated instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index cba028f..1433dc1 100644
--- a/README.md
+++ b/README.md
@@ -13,18 +13,20 @@
## Disclaimer
-This project is somewhat of a coding playground for me. It doesn't have any useful functionality. Be aware that the installation on real hardware is not recommended and may break your computer.
+This project is somewhat of a coding playground for me. It doesn't have any useful functionality (yet?). Be aware that the installation on real hardware is not recommended and may break your computer.
## Features
- From scratch (no POSIX/UNIX compatibility at all)
- No external libraries
- Efficient Multitasking
+- EXT2 filesystem
+- Minimal GUI
- Fast boot time (< 1s)
-- Small size (~10KiB)
+- Small size (~12KiB)
- Compiles with `-Wall -Wextra -pedantic-errors -std=c99 -Os`
-## Build
+## Build/Test
- Use any system running GNU/Linux
@@ -45,9 +47,11 @@ This project is somewhat of a coding playground for me. It doesn't have any usef
- nasm
- qemu
-- Build a cross compiler using `./run cross`
+- Load fonts and images into the disk image via `./run disk`
-- Run `./run build` or `./run test`
+- Run `./run`
+
+- If you need help: `./run to help`
## Licenses