]> git.lizzy.rs Git - loadnothing.git/blobdiff - README.md
Remove magic.bin
[loadnothing.git] / README.md
index 424a0cba72072870488f4ccaab112d77558059f8..384feebe4524d5284d72b85ad0fb03c96b83f7fb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # loadnothing
 Can I run boot code?
 
-Requires nasm, parted, dosfstools and qemu-system-x86.
+Requires nasm and qemu-system-x86.
 
 Rust nightly needs to be installed. If no nightly toolchain shows up
 when you run `rustup toolchain list`, install it:
@@ -25,3 +25,23 @@ Simply type `make` to build and run the project.
 QEMU may require a VNC viewer.
 
 If it's working you should see "Hello Stage2!" on the screen.
+
+# Real Hardware
+It is possible to test this project on real hardware.
+The only supported platform at the moment is x86. UEFI is not supported
+and UEFI support is unlikely to be added in the future. If you use UEFI
+make sure to enable CSM / Legacy Boot in your UEFI settings.
+If you don't have CSM you can still use a virtual machine as explained above.
+
+You can use `dd` to write the `nothing.img` file to a block device
+of your choice (but only if you've built it). It is exactly 32 MiB in size.
+
+**This will overwrite the partition table so be careful not to write
+to the wrong device.**
+
+You can then boot from the device. It should once again print "Hello Stage2!".
+
+# Developing
+It is highly recommended to run `make clean vm`.
+It takes longer to complete but is sometimes necessary
+to fully apply your changes.