summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichal Idziorek <m.i@gmx.at>2014-10-22 21:35:14 +0200
committerMichal Idziorek <m.i@gmx.at>2014-10-22 21:35:14 +0200
commit5410f2dca7b1f9198ed83b276d3f69a7a171f17e (patch)
tree9114de2badcd916f6ce4142ecbb15bafef8b7f1f /README.md
parent9a44ed2e13b44c941f28526e4b44cccc176e20cd (diff)
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 18 insertions, 11 deletions
diff --git a/README.md b/README.md
index 3a5a418..6dfac0e 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,12 @@ Usage
Attach the FoolOS.img floppy image in your favourite emulator and boot
or create a bootable USB stick by copying the raw data in the following way
-$ cat ./FloppyOS.img > /dev/sdX
+
+$ cat ./release/FloppyOS.img > /dev/sdX
+
+This image is not updated on every commit, so it might be out of date.
+You can build it yourself by running "make" in the projects
+directory. You might need some dependencies (as newlib) however.
Supported Platforms
@@ -93,16 +98,18 @@ Issues
Organization
------------
-* asm/
-* bochs/
-* boot/
-* boot0/
-* data/
-* kernel/
-* lib/
-* release/
-* screenshots/
-* tools/
+* asm/ - NASM assembler files
+* bochs/ -Bochs config files
+* boot/ - 2nd stage bootloader
+* boot0/ - 1st stage bootloader
+* data/ - datafiles (font-file and fill.asm)
+* fs/ - file system related source
+* kernel/ - kernel source
+* lib/ - some helper sources and includes
+* release/ - latest release
+* screenshots/ - latest screenshot
+* tools/ - scripts and toos
+* userspace/ - userspace related code
REFERENCES