LICENSE:
--------
    * The build script are all under GPL v2+, except for were stated, namely in patches under rebeccablackos_files/usr/share/RBOS_PATCHES or imported and
    modified files in rebeccablackos_files/usr/share/RBOS_PATCHES/ Some diffs are for software that is under a different Open Source license, for example
    Calamares is GPLv3
  
    * The Desktop wallpaper (other then the logo) is from https://store.kde.org/content/show.php/Into+Flames+%281920x1200%29?content=52726 by 'Janet' on
    KDE-look, this was documented in the commit message for commit #1985, but the file was moved, and git-svn (or git) doesn't retain the logs of moved files,
    on the git mirror

OVERVIEW:
---------
    * Use the latest ISO here: https://sourceforge.net/projects/rebeccablackos/files/

    * This is inspired by Linux distributions of the same theme (Hannah Montana Linux, and Justin Beiber Linux) that have appeared in the Linux community, only
    this is RebeccaBlackOS. This KDE blog post from 2011 also inspired the idea.
             https://web.archive.org/web/20110819224427/https://ivan.fomentgroup.org/blog/2011/05/02/splash-screens-and-qml/

    * There are many native Wayland toolkits and libraries installed, Qt, GTK, EFL, Clutter and SDL has been compiled to support Wayland.

    * Xwayland is also included, which allows X applications to run.

    * There are also other Wayland Desktop environments that are usable: Gnome Shell Wayland, Kwin, Mate, Sway, and XFCE aside from the default
    Weston Desktop shell.

    * The kernel is compiled without VTs enabled.

    * This distribution is fan made. Yes. I am a fan of Rebecca Black.

    * It is based on Debian Bookworm for Tier 1 packages.

How to use the ISO:
-------------------
    * Burn the ISO, (or set it to be "in" the CD ROM device in your favorite VM software), reboot, set the BIOS to boot from the DVD if it does not already,
    boot from the DVD. Once it boots you can use the live system.

    * The ISOs are also hybrid ISOs, meaning they can also be written directly to a flash drive.

    * The live user "rebestie" has no password.

    * The ISO is built with Remastersys, and has Casper, which makes it compatible with the USB Startup creator, despite being based off of Debian. Unetbootin
    will also work. Note that Unetbootin is not recommened if your target computer needs SimpleDRM, as it uses syslinux instead of Grub which does not properly
    allow SimpleDRM to work correctly. (See "CHANGING THE RESOLUTION ON SIMPLE HARDWARE" section for more details)

    * You could also use the test_RBOS_ISO.sh to try software on the ISO without a reboot or a VM. This is more recommended for advanced users, as it is not
    *fully* isolated. To use, Download the ISO, and download and make the test_RBOS_ISO.sh script executable, and run the script. It can be run from a
    terminal, or from your file manager.

        ** It is only recommended for expert users now. Before, it was beneficial to demonstrate sessions that could run nested, and struggled to run on VMs
        (before generic modesetting, as well as before EGL software rendering worked as well as it does now)
  
        ** It will give you a shell running with your UID, sudo works in the nested environment, and the password wil be the same as your password, rather than
        setting a weaker, or known default. (it reads the host /etc/shadow to put the same line in the nested /etc/shadow) 

        ** It requires squashfs, and also needs dialog or zenity or kdialog to be installed, and it also needs either konsole, gnome-terminal OR a standard
        x-terminal-emulator.

        ** Warning: It is not as isolated as a VM. While there are some separations to act as a play sandbox, it's NOT to be treated as a security sandbox, as
        it makes NO security guarantees.
 
How to use Wayland:
-------------------
    * The loginmanagerdisplay greeter is Weston based.

    * The LiveCD is configured to auto-login. The choices presented are the desired session type to start as the default user. All selectable sessions are
    Wayland based.

    * Most UI programs use their toolkit's Wayland backend, unless they are started with the xwaylandapp utility, which then forces most toolkits to start
    under xwayland.

BOOT OPTIONS:
-------------
      * The WaylandLoginManager responds when particular strings are passed to the kernel command line. These options are made available by the live CD boot
      menu, or on an installed system by running the command rbos-failedboot as root.

           ** wlmforceswrender :        Force all user sessions, and the WaylandLoginManager's display to be started with the environment variable
                                        LIBGL_ALWAYS_SOFTWARE=1 to force software rendering. This also forces the WaylandLoginManager to export
                                        session-specific variables for software rendering, if the wsession desktop file specifies such variables.

           ** wlmforcepixman :          Force the WaylandLoginManager's display, and the hosts for any fullscreen or kiosk shell supporting session to use the
                                        pixman renderer. Use this if there is a problem with Mesa's software renderer.

           ** wlmforcefbdev :           [Legacy option] Force the WaylandLoginManager to hide kernel mode setting support even if it is possible.
                                        (This causes newer versions of Weston to fail, as the framebuffer backend was dropped in newer versions)

           ** wlmnofbdev :              [Legacy option] Force the WaylandLoginManager to hide framebuffer support even if framebuffer support is possible.
                                        (Recent versions of Weston dropped the framebuffer backend. This is redundant now.)

           ** wlmdebug :                Forces sessions marked as debug-only to be selectable as runnable sessions, and WaylandLoginManager to log to /dev/kmsg.



       * These relevant options are also handled, (but not by the WaylandLoginManager itself)
           ** init=/bin/recinit :       Instead of using init=/bin/bash as an emergency recovery console, this starts a prompt under a user mode terminal.

           ** nomodeset :               This option is handled by the kernel. It may be slightly misleading in name, but it prevents other drivers from
                                        taking over SimpleDRM, leaving SimpleDRM as the current graphics driver. Use this if the graphics driver misbehaves,
                                        and fails to create any graphical devices.


      * This option is handled early in initramfs:
          **  norecinit=1                 This forces the initramfs recovery prompt to fall back to the system console, and not use the user mode terminal.
                                          This is not recommended for most users, as it also must be used with console=ttyS0 for debugging through a serial
                                          console.


      * These utilities assit with changing boot options on installed systems:
           ** rbos-force-simplegraphics:     Wizard for configuring the bootloader to add or remove `nomodeset to the kernel command line to force or unforce
                                             using the fallback (SimpleDRM) driver.

           ** rbos-configure-simplegraphics: Wizard for configuring the bootloader frambuffer size for hardware that requires SimpleDRM (see CHANGING THE
                                             RESOLUTION ON SIMPLE HARDWARE)

           ** rbos-force-softwarerendering:  Wizard for configuring the WaylandLoginManager to force software rendering, and Pixman where possible


CHANGING THE RESOLUTION ON SIMPLE HARDWARE:
-------------------------------------------
      * Not every video card has its own driver that supports Kernel Mode Setting. VirtualBox did not (until recently), and the emulated 'vmware' device in
      QEMU VMs does not work quite right with the vmwgfx driver. Before simpledrm, hardware without proper modesetting support required framebuffer support.
      While possible, there was the problem that Wayland based display servers that have framebuffer backends are rare.

      * The *bootloader* is where the video memory for this driver is prepared, before the kernel starts. Grub tries its best to detect your resolution, with
      one that is supported by both your BIOS and your monitor. However, the resolution can be customized, especially on VMs which may tend to default to a
      smaller screen size.

      * For Live CD mode, in the boot menu, hit the 'e' key. and set SetCustomResolution to 1 (from 0) and then change the set gfxmode= line to your desired
      resolution, and hit "CTRL+X"

      * For installed, a utility, rbos-configure-simplegraphics is provided.

BUILDING:
---------
     * Building your own ISO is simple. Simply download the SVN by ensuring subversion is installed, and running the command:
          svn checkout svn://svn.code.sf.net/p/rebeccablackos/code/
     run the rebeccablackos_builder.sh, and then select the build architecture to run. The build process only works on Linux computers, but should work on
     most distros. A full build from scratch may take several hours to about a day depending on your hardware, and may take several GB. If nothing is selected
     to be rebuilt on the second build attempt, it may take less than an hour depending on your hardware.

     * It requires the 'ar' utility from the 'binutils' package for the extraction of debootstrap to work

     * If you need to select specific revisions of the packages, copy buildcore_revisions_(architecture).txt into /var/cache/RBOS_Build_Files . Ensure that the
     file is not tampered with maliciously, as it is *executed* by the build scripts to set the revision. Only revision files built by SVN commit 3418 and
     above are fully compatible for setting the package source versions/exact commits. Revisions files can also specify a snapshot date for the underlying
     Debian packages, but this only works for revisions files built since commit 5555.

     * Note that Commit 6413 corrected a bash 5.0 quirk in how the function-name safe names were handled, to prevent too many characters from being escaped.
     This issue went unnoticed for likely since commit 5822 with the switch to Debian Buster, impacting the built revisions file for the release on 2019-10-05

     * CONTROL FILES (relative to /var/cache/RBOS_Build_Files):
       ** DontDownloadDebootstrapScript:                          Delete this file to force the downloaded debootstrap in RBOS_Build_Files to run again at the
                                                                  next build
       ** DontRestartArchives(architecture):                      Delete this file to force all the downloaded packages to be downloaded again for the 
                                                                  respective architecture.
       ** DontRestartSourceDownload(architecture):                Delete this file to force all the downloaded source repositories to be downloaded again for
                                                                  the respective architecture.
       ** DontRestartPhase1(architecture):                        Delete this file to force Phase1 to debootstrap again for the respective architecture. This
                                                                  only hosts the smaller chroot system that downloads everything
       ** DontRestartPhase2(architecture):                        Delete this file to force Phase2 to debootstrap again for the respective architecture. This
                                                                  is the chroot that gets copied to Phase3, and is on the output ISO files.
       ** DontRestartBuildoutput(architecture):                   Delete this file to force all deb packages to rebuild for the respective architecture. This
                                                                  will increase the build time.
       ** DontRestartRustDownload(architecture):                  Delete this file to force build_core to re-download Rust
       ** DontStartFromScratch(architecture):                     Delete this file to force delete everything included downloaded repositories for the
                                                                  respective architecture, and cause it to start from scratch.
       ** DontRestartCargoDownload(architecture):                 Clear the Cargo cache
       ** DontRestartRustDownload(architecture):                  Force build_core to download a new build of Rust
       ** build/(architecture)/buildoutput/control/(packagename): Delete these files to specify a specific package to rebuild.
       ** buildcore_revisions_(architecture).txt:                 Add a revisions file into this path, to specify particular packages, as described above
       ** RestartPackageList_(architecture).txt:                  Add in the list of packages (as in the files in build/(architecture)/buildoutput/control/ ).
                                                                  One per each line. For batch resetting particular packages
       ** DontForceSnapshotBuild(architecture):                   Delete this file only after the first run is complete, before the next build. This forces
                                                                  temporary chroots to be built