Cleanup README.md

Author: automas-dev

README.md

@@ -7,7 +7,7 @@ Active and planned work is tracked in [notes.md](notes.md)
 For current specs see
 
 - [memory.md](memory.md)
-- ~~[boot_stages.md](boot_stages.md)~~
+- [boot.md](boot.md)
 - ~~[filesystem.md](filesystem.md)~~
 
 ## Goals
@@ -18,6 +18,21 @@ The OS will be finished when all of the following are implemented.
 2. Compiler for at least Assembly or C
 3. Playable Minecraft Clone
 
+The following lists show the planned development stages and planned tasks to
+achieve these goals.
+
+### Near Near Term
+
+- [x] Read extended kernel form floppy
+- [x] Switch to protected mode
+- [x] some stdio.h
+- [x] printf
+- [x] some string.h
+- [x] keyboard driver
+- [x] ata driver
+- [x] terminal with command parsing
+- [x] circular buffer + tests (builtin, needs separating)
+
 ### Near Term
 
 - [ ] Kernel stats (stats command returns # disk io, keys, mounts, etc.)
@@ -45,6 +60,9 @@ The OS will be finished when all of the following are implemented.
 
 ### Long Term
 
+These tasks will be broken down further after completion of Near Term, when
+there is a better foundation and design to work with.
+
 - [ ] Switch to 2d graphics mode
 - [x] Virtual memory pages / memory paging
 - [ ] Memory permissions (eg. stack can't exec, code can't write)
@@ -57,73 +75,13 @@ The OS will be finished when all of the following are implemented.
 
 ### Long Long Term
 
+These tasks will be broken down further after completion of Long Term, when
+there is enough support for their development.
+
 - [ ] Graphics card driver (pseudo opengl)
 - [ ] Threading / multi-process
 - [ ] (Maybe) Multiboot or GRUB?
 
-## Completed
-
-- Read extended kernel form floppy
-- Switch to protected mode
-- some stdio.h
-- printf
-- some string.h
-- keyboard driver
-- ata driver
-- terminal with command parsing
-- circular buffer + tests (builtin, needs separating)
-
-## Boot Stages
-
-This describes the planned stages and steps, it does not represent the current
-implementation or progress.
-
-### BIOS
-
-1. Load boot sector into memory at 0x7c00
-
-### Stage 1
-
-1. Store boot drive id
-2. Setup stage 1 stack at 0x06fff
-3. Read memory map to 0x500
-4. Read stage 2 from boot drive
-5. Setup GDT
-7. Switch to protected mode
-
-### Stage 2
-
-1. ~~Move boot parameters out of first page~~
-   1. ~~Set first page to throw error on access to 0~~
-2. Setup ISR and IDT
-4. Setup Memory Allocator
-   1. Physical Memory
-   2. Virtual Memory (paging)
-5. Enable Paging
-6. Load VGA driver
-   1. Clear screen
-   2. Print hello
-8.  Load ATA driver
-   1. Mount fs
-   2. Read kernel into page directory
-9.  Start kernel
-
-### Stage 3 - OS
-
-1. Load drivers
-   1. VGA / 2d graphics
-   2. Keyboard
-   3. Disk
-   4. Filesystem
-   5. etc.
-2. Mount os drive / partition? (does this happen in stage 2?)
-3. Setup kernel service calls
-4. Begin user space applications loop
-   1. Create page directory
-   2. Load elf binary
-   3. Switch to Ring 3
-5. Shell
-
 ## Setup
 
 ```sh

boot.md

@@ -0,0 +1,50 @@
+# Boot Stages
+
+This describes the planned stages and steps, it does not represent the current
+implementation or progress.
+
+## BIOS
+
+1. Load boot sector into memory at 0x7c00
+
+## Stage 1
+
+1. Store boot drive id
+2. Setup stage 1 stack at 0x06fff
+3. Read memory map to 0x500
+4. Read stage 2 from boot drive
+5. Setup GDT
+7. Switch to protected mode
+
+## Stage 2
+
+1. ~~Move boot parameters out of first page~~
+   1. ~~Set first page to throw error on access to 0~~
+2. Setup ISR and IDT
+4. Setup Memory Allocator
+   1. Physical Memory
+   2. Virtual Memory (paging)
+5. Enable Paging
+6. Load VGA driver
+   1. Clear screen
+   2. Print hello
+8.  Load ATA driver
+   1. Mount fs
+   2. Read kernel into page directory
+9.  Start kernel
+
+## Stage 3 - OS
+
+1. Load drivers
+   1. VGA / 2d graphics
+   2. Keyboard
+   3. Disk
+   4. Filesystem
+   5. etc.
+2. Mount os drive / partition? (does this happen in stage 2?)
+3. Setup kernel service calls
+4. Begin user space applications loop
+   1. Create page directory
+   2. Load elf binary
+   3. Switch to Ring 3
+5. Shell

notes.md

@@ -5,10 +5,14 @@ checked off. Use the task template bellow for larger tasks that need some design
 work or require additional information. Those can be moved under the Completed
 section once they are finished.
 
-- [ ] Add design doc for boot stages and move out of readme
-- [ ] Clean up goals in readme
-  - [ ] Remove completed section (make checked boxes in list)
-  - [ ] Cleanup Goals term lists
+- [ ] Documentation
+  - [x] Add design doc for boot stages and move out of readme
+  - [ ] Update boot stages to be more accurate
+  - [ ] Filesystem documentation
+  - [ ] Move doc files under design folder
+  - [ ] Clean up goals in readme
+    - [ ] Remove completed section (make checked boxes in list)
+    - [ ] Cleanup Goals term lists
 - [ ] mmu
   - [ ] free interior pages when malloc free's entire virtual page
 - [ ] tar