summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAda Christine <adachristine18@gmail.com>2022-01-09 18:21:05 +0000
committerAda Christine <adachristine18@gmail.com>2022-01-09 18:21:05 +0000
commite3748940c9f5b87008221c2a4fe544f79a2c7363 (patch)
tree010c799c699d631a4f57446cc2781ec5a690c855 /README.md
parenta7530db6b51acbe98f124beec89b181debf74e24 (diff)
more readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index 342be6b..746d2b0 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,28 @@ this code sucks and should not be used under any circumstances
whoever is outside my house yelling "comment your code!" i will never comment my code
+## how to use
+
+in order to use this you will require the following:
+
+- a gcc cross-compiler targeting x86\_64-elf. instructions [here](https://wiki.osdev.org/GCC_Cross-Compiler)
+- qemu supporting x86\_64
+- an OVMF installation usable as a firmware for qemu
+- gnu-efi
+
+generally it is only currently possible to build from a POSIX-like system.
+this is not a rule, but i do not currently support any other means
+
+## how to contribute
+
+if my project has somehow piqued your interest and you'd like to contribute,
+please feel free to create your own fork and send a PR.
+
+## copyright notice
+
+i maintain no copyright over any of this. i don't care. this is a passion project
+and not something i ever expect to be worth the time or effort to plagairize or
+be worth anything commercially. good luck if you think so, though. your estimation
+of the quality of my code and ability as a programmer are clearly much higher than
+my own
+