diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 33 insertions, 7 deletions
@@ -5,7 +5,9 @@ Welcome to the Hyra Operating System project! Project Goal: -------------- -The goal of this project is to create a modern operating system, taking inspiration from NetBSD and incorporating new ideas and design plans. Our mission is to design a new modernized POSIX-like standard to provide a robust and versatile environment for developers and users. +The goal of this project is to redefine what modern operating systems are while taking inspiration from BSD. Hyra does not use +POSIX by default and instead uses the [OSMORA Uniform System Interface (OUSI)](https://osmora.org/oap/oap-0002). Hyra also does +not use CPIO for its initramfs like other operating systems typically would and instead uses the [OSMORA Archive Format (OMAR)](https://osmora.org/oap/oap-0005). Getting Started: ---------------- @@ -15,21 +17,45 @@ Next, to configure for x86_64 just run configure: `./configure` -Now you'll need to build the cross compiler by running: +After running the configure script, you can now actually build Hyra: -`make cross` +`./hyra-build.sh` -This may take awhile so just sit back, relax and do something else like... well I'm not you so -I don't know what you like. +This will generate a new `Hyra.iso` file. -After the cross compiler is done building you can build and run the project in a virtual machine: -`make; make run` +Default User: +---------------- +Upon booting, the `login` program will ask for user credentials. The default username is `root` and the default +password is also `root`. + +Programs: +---------------- +The Hyra userspace provides the user various programs that they can run, examples of +such programs include: + +- ``beep`` - Play a tone +- ``cat`` - Print files to stdout +- ``date`` - Get the current date or set system time +- ``echo`` - Print a line of text +- ``elfdump`` - Get information about an ELF binary +- ``fetch`` - System fetch! A must have :~) +- ``getconf`` - Get system configuration values +- ``mex`` - OSMORA hexdump utility +- ``sleep`` - Sleep for a number of seconds +- ``kmsg`` - Read the kernel message buffer +- ``readcore`` - Read coredump files + +And more! See ``usr.bin/*`` Documentation: -------------- Documentation will be in the form of comments throughout the codebase and can also be found in the share/ directory within the project root. +Hyra running on bare metal: +-------------- + + License: -------- This project is licensed under the BSD-3 clause (SPDX Identifier: BSD-3-Clause) |