Aren
/
toaruos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Big readme update

This commit is contained in:
K. Lange 2018-07-22 01:43:58 +09:00
parent 5f7b7c9f38
commit b82cd08aee
1 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,11 +1,69 @@
# ToaruOS-NIH
![screenshot](https://i.imgur.com/vwVV7sG.png)
![screenshot](https://i.imgur.com/G8G1dwf.png)
ToaruOS-NIH is a distribution of ToaruOS which contains no third-party components. Its bootloader, kernel, modules, C library, and userspace applications are all written by the ToaruOS development team and direct contributors.
This distribution aims to eventually replace the core of the mainline ToaruOS, with the various third-party components building against our own C library. This is a long-term project, and developing the C library to the point where it is useful for this purpose is not expected to be completed for quite some time.
## Pre-Built Images
Releases are occasionally posted on [GitHub](https://github.com/klange/toaru-nih/releases), and nightlies are available [from toaruos.org](https://toaruos.org/nih.iso).
### Running ToaruOS-NIH
It is recommended that you run ToaruOS-NIH in an emulator - specific Qemu or VirtualBox, though some testing has been done in VMware Workstation (reasonable, but missing driver support) and Bochs (not recommended).
#### QEMU
1GB of RAM and an Intel AC'97 sound chip are recommended:
```
qemu-system-i386 -cdrom image.iso -serial mon:stdio -m 1G -soundhw ac97,pcspk -enable-kvm -rtc base=localtime
```
You may also use OVMF with the appropriate QEMU system target:
```
qemu-system-x86_64 -cdrom image.iso -serial mon:stdio -m 1G -soundhw ac97,pcspk -enable-kvm -rtc base=localtime \
-bios /usr/share/qemu/OVMF.fd
```
#### VirtualBox
ToaruOS should function either as an "Other/Unknown" guest or an "Other/Uknown 64-bit" guest with EFI.
All network chipset options should work except for `virtio-net` (work on virtio drivers has not yet begun).
It is highly recommended, due to the exisence of Guest Additions drivers, that you provide your VM with at least 32MB of video memory to support larger display resolutions - especially if you are using a 4K display.
Ensure that the audio controller is set to ICH AC97 and that audio output is enabled (as it is disabled by default in some versions of VirtualBox).
Keep the system chipset set to PIIX3 for best compatibility. 1GB of RAM is recommended.
#### VMWare
Support for VMWare is experimental.
As of writing, the following configuration has been tested as functioning:
- Create a virtual machine for a 64-bit guest. (ToaruOS-NIH is 32-bit, but this configuration selects some hardware defaults that are desirable)
- Ensure the VM has 1GB of RAM.
- Remove the hard disk from the VM.
- Remove the sound card from the VM. VMWare implements an Ensoniq chipset we do not have drivers for.
- Manually set the `firmware` value to `efi` in the VMX file. The BIOS loader has known issues under VMWare.
- For network settings, the NAT option is recommended.
#### Bochs
Using Bochs to run ToaruOS is not advised; however the following configuration options are recommended if you wish to try it:
- Attach the CD and set it as a boot device.
- Ensure that the `pcivga` device is enabled or ToaruOS will not be able to find the video card through PCI.
- Provide at least 512MB of RAM to the guest.
- If available, enable the `e1000` network device (this has never been tested).
- Clock settings of `sync=realtime, time0=local, rtc_sync=1` are recommended.
## Implementation Details
All source code for the entire operating system is included in this repository.