Add basic documentation

finchie
Dec 25, 2023, 7:45 PM
RE6IE72ENK5MU7VZAINXM5IMA7H2HO7NDCMAKNOPMCHE7DBM2FCQC

Dependencies

Change contents

  • file addition: README.md (----------)
    [2.18]
    # Simple UEFI QEMU runner for HexOS
    A modified version of the [disk image creation template](https://github.com/rust-osdev/bootloader/blob/main/docs/create-disk-image.md) from the [rust-osdev bootloader repo](https://github.com/rust-osdev/bootloader). Unlike the template, this runner is UEFI-only but otherwise very similar.
  • file addition: README.md (----------)
    [4.1]
    # HexOS
    Status: kernel builds and runs in QEMU
    Goal: a simple graphical desktop
    Stretch goal: explore desktop-specific OS design
    Primary resources:
    - [Writing an OS in Rust](https://os.phil-opp.com), kernel written loosely following this guide
    - [OSDev Wiki](https://wiki.osdev.org/Main_Page) for more specific documentation
    - [UEFI, PC boot process and UEFI with QEMU](https://joonas.fi/2021/02/uefi-pc-boot-process-and-uefi-with-qemu) for learning about UEFI
    - [Rust Embedded Raspberry Pi OS](https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials) as another Rust OS reference
    ## Building
    Requires the `rust-src` component and the `x86_64-unknown-none` (nightly) target from rustup, along with `qemu-system-x86_64`. Then just `cargo run`!
  • file addition: LICENSE (----------)
    [4.1]
    ANTI-CAPITALIST SOFTWARE LICENSE (v 1.4)
    Copyright © 2023 Finchie
    This is anti-capitalist software, released for free use by individuals and organizations that do not operate by capitalist principles.
    Permission is hereby granted, free of charge, to any person or organization (the "User") obtaining a copy of this software and associated documentation files (the "Software"), to use, copy, modify, merge, distribute, and/or sell copies of the Software, subject to the following conditions:
    1. The above copyright notice and this permission notice shall be included in all copies or modified versions of the Software.
    2. The User is one of the following:
    a. An individual person, laboring for themselves
    b. A non-profit organization
    c. An educational institution
    d. An organization that seeks shared profit for all of its members, and allows non-members to set the cost of their labor
    3. If the User is an organization with owners, then all owners are workers and all workers are owners with equal equity and/or equal vote.
    4. If the User is an organization, then the User is not law enforcement or military, or working for or under either.
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.