Skip to content

Commit

Permalink
docs: readme: iso link
Browse files Browse the repository at this point in the history
  • Loading branch information
portasynthinca3 committed Jul 30, 2024
1 parent efea2d8 commit d3ecca2
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,17 @@ Base image:
- [ ] Other things

## I wanna run it!!!!
I see that I'm not the only one fueled by bad decisions. Anyways, you will need:

### Download
You can download an ISO built from the latest commit over on the
[Releases](https://github.com/portasynthinca3/boss/releases) page. However, I
suggest that you instead build the OS from scratch.

Currently, the OS does not display anything on the screen. Instead, refer to
output from the serial port.

### Build
You will need:
- Git
- Just
- MTools
Expand All @@ -159,14 +169,5 @@ $ make qemu
Currently, the OS does not display anything on the screen. Instead, refer to
serial output that's relayed to the terminal.

### No, I wanna run it on bare hardware
Please don't. Run `make` and make a FAT32 disk image from `boot/esp` yourself.
Note, again, that the OS currently only outputs to the serial port, thus you
won't be able to see anything on the screen.

### I need an ISO
The OS is not anywhere near the state where I'm comfortable with releasing a
ready-to-run ISO to the general public.
## Credits
A huge thank you to @thecaralice and @polina4096 for helping me understand Rust.

0 comments on commit d3ecca2

Please sign in to comment.