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

Created New Release Template (markdown)

K Lange 2018-11-28 11:32:15 +09:00
parent a667b3107b
commit 3544d3e90e
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
New-Release-Template.md Normal file

@ -0,0 +1,32 @@
*This template intends to provide an extensive explanation of ToaruOS to be included in each set of release notes, as well as a standard format for changes.*
# ToaruOS vX.Y.Z
*Screenshots go here*
## What's New in vX.Y.Z?
This release features THINGS.
## What is ToaruOS?
ToaruOS is a hobbyist, educational operating system for x86 PCs, focused primarily on use in virtual machines. It provides a Unix-like environment, complete with a graphical desktop interface, shared libraries, feature-rich terminal emulator, and support for running Python 3.6, GCC, and several other ports. The core of ToaruOS, provided by the CD images in this release, is built completely from scratch. The bootloader, kernel, drivers, C standard library, and userspace applications are all original software created by the authors, as are the graphical assets.
## Who wrote ToaruOS?
ToaruOS is primarily written by a single maintainer, with several contributions from others. A complete list of contributors is available from [AUTHORS](https://github.com/klange/toaruos/blob/master/AUTHORS).
## Running ToaruOS
It is recommended that you run ToaruOS in a virtual machine / emulator, for maximum compatibility. ToaruOS's driver support is limited, and running on real "bare metal", while possible, does not provide the most complete experience of the OS's capabilities except on very particular hardware. ToaruOS is regularly tested in VirtualBox, QEMU, and VMWare Player, and can be successfully booted (with poor performance) in Bochs. ToaruOS is intended to run from a live CD, though it is possible to install to a hard disk. Additional details on running ToaruOS in different virtual machines is available [from the README](https://github.com/klange/toaruos#running-toaruos).
## Changelog
- *This is the long-form bullet-point list of changes from the last release*
## Known Issues
- The Help Browser remains unimplemented in this release.
- The File Browser's address bar is read-only.
- Several utilities are missing functionality.
- The libc's implementation of `scanf` is incredibly incomplete.