Skip to content

Commit

Permalink
docs: updated spec, added instructions
Browse files Browse the repository at this point in the history
Updated architecture specification and added instructions to run/compile. Also specified development status.
  • Loading branch information
Icarus131 authored Aug 13, 2023
1 parent cbc11f0 commit dc6d78c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# IcarOS

- IcarOS is my documented journey while exploring OSDev
- A simple, minimal and small skeletal 32-bit operating system written in Assembly and C
- A simple, minimal and small skeletal 64-bit operating system written in Assembly and C
- Currently working on a Rust port

### To run, just execute the make file.
- You will need to install certain dependencies to cross-compile. Installation script for Arch Linux can be found in `src/utils`
- You can also do `./Makefile`
- You will need the full QEMU package on linux to run the bootloader
- Once you install qemu you can run the Makefile that contains rules to use the crosscompiler.
- The provided script for the cross-compiler currently works only for linux, but can also be made for other platforms by installing the requirements given in the script

- As of now, it can boot and jump to the kernel and execute from there
- As of now, it can boot and jump to the kernel and execute from there for 32 bit, and clears the screen and waits for jump to kernel for 64-bit

---
- *ℹ️ The OS is still in it's development phase.*


#### Preview:
Expand Down

0 comments on commit dc6d78c

Please sign in to comment.