summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichal Idziorek <m.i@gmx.at>2014-11-17 21:39:06 +0100
committerMichal Idziorek <m.i@gmx.at>2014-11-17 21:39:06 +0100
commit9c98882150b903343afb349e74ee850bfa16b5c2 (patch)
tree5ea662aaa3999731b3934aadb6a084d415ebf16b /README.md
parent55dc29289e41e95a3098f757288b5a1593fd728b (diff)
update README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 16 insertions, 22 deletions
diff --git a/README.md b/README.md
index 6360be1..4987135 100644
--- a/README.md
+++ b/README.md
@@ -24,18 +24,17 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+
Usage
-----
-Attach the FoolOS.img (found in the ./release directory) floppy image in your
-favourite emulator and boot or create a bootable USB stick by copying the raw
-data in the following way:
+Attach the FoolOS.img or FoolOS.vdi image in your favourite emulator and
+boot or create a bootable USB stick by copying the raw data in the
+following way:
-$ cat ./release/FloppyOS.img > /dev/sdX
+$ cat FoolOS.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.
+You will require some dependencies (as newlib) in order to build.
Supported Platforms
@@ -66,8 +65,8 @@ Some might be disabled temporarily due to conflicts or regressions.
* ACPI / MP
* Floppy disk driver
* PS2 Mouse driver
-* Keyboard driver (redesign!)
-* VESA
+* Keyboard driver
+* VESA Support
* Spinlocks
* Simple Shell
* Simple Ext2 driver (read-only)
@@ -76,19 +75,14 @@ Todos
-----
* set up os-specific toolchain!
-* set dependancies in the makefile properly!
+* use linker script!
+* ELF binaries (also kernel itself)
-* User space
-* ELF binaries
-* reenable virtual memory!
-* reenable SMP and MULTITASKING!
-* implement more syscalls: fork, execv
+* Real User space
+* implement more syscalls: fork, etc.
* E1000 driver
* Networking stack
-* copy files over network! read/write
-
-* window manager
* 64-bit
* ARM
@@ -96,21 +90,20 @@ Todos
* USB driver
* Higher half kernel
* Web-server
-* Port coreutils, gcc?
+* Port coreutils, gcc, ..
Issues
------
* Turning on some gcc optimizations breaks the kernel
* Assumed support for VESA mode 0x114 with linear addressing.
-* Control of stack heap growth?
+* Control of bss size!?
* Protect ringbuffer in syscall: disable interrupts on local cpu before spinlocking
Organization
------------
-* release/ - latest release (usually out of date)
* screenshots/ - latest screenshot
* userspace/ - userspace related code
@@ -121,6 +114,7 @@ Organization
* asm/ - kernel assembler code
* kernel/ - kernel source
+
* lib/ - some helper sources and includes
* fs/ - file system related source
* video/ - screen output (VESA and text)
@@ -130,7 +124,6 @@ Organization
* bochs/ -Bochs config files
-
REFERENCES
==========
@@ -143,3 +136,4 @@ REFERENCES
* http://forum.osdev.org/viewtopic.php?f=1&t=10944
* http://wiki.osdev.org/Virtual_8086_Mode
* http://wiki.xomb.org/index.php?title=ACPI_Tables
+* and many many more...