2.5 KB

  1. #!/bin/bash
  2. VERSION=$(git describe --exact-match --tags)
  3. LAST=$(git describe --abbrev=0 --tags ${VERSION}^)
  4. CHANGELOG=$(git log --pretty=format:%s ${LAST}..HEAD | grep ':' | sed -re 's/(.*)\:/- \`\1\`\:/' | sort)
  5. cat <<NOTES
  6. # ToaruOS ${VERSION}
  7. Put a screenshot here.
  8. ## What's New in ${VERSION}?
  9. Describe the release here.
  10. ## What is ToaruOS?
  11. ToaruOS is a hobbyist, educational operating system for x86-64 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, GCC, Quake, 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.
  12. ## Who wrote ToaruOS?
  13. ToaruOS is primarily written by a single maintainer, with several contributions from others. A complete list of contributors is available from [AUTHORS](
  14. ## Running ToaruOS
  15. 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](
  16. ## Release Files
  17. \`image.iso\` is the standard build of ToaruOS, built by the Github Actions CI workflow. It uses ToaruOS's native bootloaders and should work in most virtual machines using BIOS.
  18. ## Changelog
  19. ${CHANGELOG}
  20. ## Known Issues
  21. - The SMP scheduler is known to have performance issues.
  22. - Several utilities, libc functions, and hardware drivers are missing functionality.
  23. - There are many known security issues with ToaruOS. You should not use ToaruOS in a production environment - it is a hobby project, not a production operating system. If you find security issues in ToaruOS and would like to responsibly report them, please file a regular issue report here on GitHub.
  24. NOTES