summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md38
1 files changed, 21 insertions, 17 deletions
diff --git a/README.md b/README.md
index 06ca753..0dedd78 100644
--- a/README.md
+++ b/README.md
@@ -5,39 +5,40 @@ Welcome to FoolOS
Abstract
--------
-Welcome to the Home of the most useless operating system.
+Welcome to the Home of the worlds most useless operating system.
Quick-start
-----------
-Simply boot from the FoolOS.iso in your favourite emulator or
-_dd_ to an USB stick and test on real hardware.
+Simply boot from the __FoolOS.iso__ in your favourite emulator
+or __dd__ to an USB stick and test on real hardware.
Features
--------
-* Booting with Multiboot (grub)
+* Booting with Multiboot (e.g. GRUB 2)
* 32-bit protected mode
-* VESA and EGA-standard text-mode
* Logging to COM1
* Parsing ACPI and Multiboot Data (partly)
* Symmetrical Multiprocessing with LAPIC and IOAPIC
* APIC and PIT Timers
-* Seperate GDT and IVT on each CPU
+* Seperate GDT and IVT for each CPU
* Paging / Virtual Memory
* RAM image (ext2 read-only)
-* VESA Framebuffer with fallback to a text-only terminal
* Standard streams (stdin/stdout/stderr)
-* Mouse and Keyboard
+* Mouse and Keyboard support
* Multithreading & Multitasking
-* Kernel and Userspace Tasks (ring 0/ring 3)
+* Kernel and Userspace Tasks
* CPU Private Memory
-* Superfast Task Scheduler
-* Newlib C library for Userspace
-* ELF binaries
+* Support for ELF binaries.
* IRQ Handling Framework
-* Spinlocks
-* Simple Shell
-* PCI bus scanning
+* Finegrained Spinlocks
+* Superfast Task Scheduler
+* PCI Bus scanning
+* VESA Framebuffer with fallback to a text-only terminal
+* C-library for Userspace (Newlib)
+* Simple FoolShell
+* Snake Game
+* Ships with other useless userspace software
_Please note that most features are only very rudimentary and mostly buggy._
@@ -48,8 +49,11 @@ providing a multiboot header and the entry point _start().
This in turn calls the C function kernel_main().
-Prequisites
------------
+Building
+--------
+
+You should at least setup a gcc cross-compiler and setup newlib to
+build FoolOS yourself.
GCC CROSS-COMPILER (i686-elf)