diff --git a/README.md b/README.md index 4b88d9e..54febc6 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Otherwise, the build is as normal. Once the cross-compiler is built, the OS can be built by simply typing `make`. -## Additional setup (on Linux or Mac) +## Additional setup (on Linux or Mac (Unsupported on Mac) ) To run & debug the OS, you willl need to install QEMU, GRUB, and GDB. @@ -37,7 +37,7 @@ Installing GRUB on: 1. Ubuntu. GRUB is already installed. 2. Arch. If you have chosen GRUB as your bootloader, run `sudo pacman -S dosfstools libisoburn`, as arch by default does not have the necessary tools for grub-mkrescue to work, otherwise run `sudo pacman -S grub dosfstools libisoburn` 3. Another linux distro. GRUB is likely already installed, but if it is not, you will need to use your distribution's package manager to install GRUB. -4. Mac. You will need to install Homebrew, then install the formula i386-elf-grub. +4. Mac. You will need to install Homebrew, then run `brew install i386-elf-grub` Installing QEMU on @@ -49,9 +49,9 @@ Installing QEMU on Installing GDB on 1. Ubuntu. Run `sudo apt get install gdb` -2. Arch. Run `sudo pacman -S install gdb` +2. Arch. Run `sudo pacman -S gdb` 3. Another linux distro. Use your distribution's package manager to install GDB. -4. Mac. Run `brew install gdb` (Note: It will warn about an unsigned binary, but this will have no impact on debugging the OS) +4. Mac. Run `brew install gdb` -After this, you can run the OS in QEMU by typing `make run`, and start a remote debugging session by typing `make debug`. +After this, you can run the OS in QEMU by typing `make run`, or run the OS and start the debugger by typing `make debug`. The serial port output of the OS is redirected to a file callled serout in the main directory.