From 884a5e9bbed0e5374fa6b186c0b5390ff547e2aa Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Tue, 3 Oct 2023 10:57:31 -0700 Subject: [PATCH 01/20] possible fix --- rabbithole/services/detect-monitors.lua | 40 +++++++++++++++---------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/rabbithole/services/detect-monitors.lua b/rabbithole/services/detect-monitors.lua index 851a4cb..518ed83 100644 --- a/rabbithole/services/detect-monitors.lua +++ b/rabbithole/services/detect-monitors.lua @@ -18,30 +18,38 @@ function DetectMonitor.new() end function DetectMonitor.setup_screens() - awful.spawn.easy_async_with_shell("xrandr -q | grep ' connected'", function(stdout) - local screens = gears.string.split(stdout, "\n") - for _, line in pairs(screens) do + awful.spawn.easy_async_with_shell("xrandr -q", function(stdout, stderr, exitreason, exitcode) + if exitcode ~= 0 then + naughty.notify({ title = "Error Querying xrandr", text = stderr, preset = naughty.config.presets.critical }) + return + end + + local connected_screens = {} + for line in stdout:gmatch("[^\r\n]+") do local screen_name = line:match("^(.-) connected") if screen_name then - -- Find and set the highest available resolution for the connected screen - local max_res = line:match("%d+x%d+") - if max_res then - awful.spawn.easy_async_with_shell("xrandr --output " .. screen_name .. " --mode " .. max_res, function() - -- save users setup for the future - awful.spawn.easy_async_with_shell("autorandr --save " .. screen_name, function() - naughty.notify({ title = "Automatic Display Configuration", text = "Applied and saved configuration for " .. screen_name }) - end) - end) - else -- default to auto detection if display can't be determined - awful.spawn.easy_async_with_shell("autorandr --change", function() - naughty.notify({ title = "Automatic Display Configuration", text = "Maximum resolution could not be determined for " .. screen_name .. ". Autodetected settings." }) + connected_screens[#connected_screens + 1] = {name=screen_name, xrandr_output=line} + end + end + + for _, screen_info in ipairs(connected_screens) do + local max_res = screen_info.xrandr_output:match(" (%d+x%d+) %s+%d+.%d%d?%*?") + if max_res then + awful.spawn.easy_async_with_shell("xrandr --output " .. screen_info.name .. " --mode " .. max_res, function() + awful.spawn.easy_async_with_shell("autorandr --save " .. screen_info.name, function() + naughty.notify({ title = "Monitor Configuration", text = "Applied and saved configuration for " .. screen_info.name }) end) - end + end) + else + awful.spawn.easy_async_with_shell("autorandr --change", function() + naughty.notify({ title = "Monitor Configuration", text = "Maximum resolution could not be determined for " .. screen_info.name .. ". Applied autorandr --change." }) + end) end end end) end + local debounce_timer = nil local debounce_time = 2 -- in seconds From f14d9721bf9852f094c57d6bd8de7f7099c25a6f Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Tue, 3 Oct 2023 11:10:19 -0700 Subject: [PATCH 02/20] fixed? --- rabbithole/services/detect-monitors.lua | 39 ++++++++++--------------- 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/rabbithole/services/detect-monitors.lua b/rabbithole/services/detect-monitors.lua index 518ed83..32990f2 100644 --- a/rabbithole/services/detect-monitors.lua +++ b/rabbithole/services/detect-monitors.lua @@ -18,38 +18,29 @@ function DetectMonitor.new() end function DetectMonitor.setup_screens() - awful.spawn.easy_async_with_shell("xrandr -q", function(stdout, stderr, exitreason, exitcode) - if exitcode ~= 0 then - naughty.notify({ title = "Error Querying xrandr", text = stderr, preset = naughty.config.presets.critical }) - return - end - - local connected_screens = {} - for line in stdout:gmatch("[^\r\n]+") do + awful.spawn.easy_async_with_shell("xrandr -q | grep ' connected'", function(stdout) + local screens = gears.string.split(stdout, "\n") + for _, line in pairs(screens) do local screen_name = line:match("^(.-) connected") if screen_name then - connected_screens[#connected_screens + 1] = {name=screen_name, xrandr_output=line} - end - end - - for _, screen_info in ipairs(connected_screens) do - local max_res = screen_info.xrandr_output:match(" (%d+x%d+) %s+%d+.%d%d?%*?") - if max_res then - awful.spawn.easy_async_with_shell("xrandr --output " .. screen_info.name .. " --mode " .. max_res, function() - awful.spawn.easy_async_with_shell("autorandr --save " .. screen_info.name, function() - naughty.notify({ title = "Monitor Configuration", text = "Applied and saved configuration for " .. screen_info.name }) + local max_res = line:match(" (%d+x%d+)") + if max_res then + awful.spawn.easy_async_with_shell("xrandr --output " .. screen_name .. " --mode " .. max_res, function() + -- save users setup for the future + awful.spawn.easy_async_with_shell("autorandr --save " .. screen_name, function() + naughty.notify({ title = "Automatic Display Configuration", text = "Applied and saved configuration for " .. screen_name }) + end) end) - end) - else - awful.spawn.easy_async_with_shell("autorandr --change", function() - naughty.notify({ title = "Monitor Configuration", text = "Maximum resolution could not be determined for " .. screen_info.name .. ". Applied autorandr --change." }) - end) + else -- default to auto detection if display can't be determined + awful.spawn.easy_async_with_shell("autorandr --change", function() + naughty.notify({ title = "Automatic Display Configuration", text = "Maximum resolution could not be determined for " .. screen_name .. ". Autodetected settings applied." }) + end) + end end end end) end - local debounce_timer = nil local debounce_time = 2 -- in seconds From 3136af196d2e9976188374c73493d38ae4c60648 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Tue, 3 Oct 2023 11:30:53 -0700 Subject: [PATCH 03/20] ffs --- rabbithole/services/detect-monitors.lua | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/rabbithole/services/detect-monitors.lua b/rabbithole/services/detect-monitors.lua index 32990f2..456cf69 100644 --- a/rabbithole/services/detect-monitors.lua +++ b/rabbithole/services/detect-monitors.lua @@ -18,20 +18,20 @@ function DetectMonitor.new() end function DetectMonitor.setup_screens() - awful.spawn.easy_async_with_shell("xrandr -q | grep ' connected'", function(stdout) + awful.spawn.easy_async_with_shell("xrandr -q | awk '/ connected/{print $0; getline; print}'", function(stdout) local screens = gears.string.split(stdout, "\n") - for _, line in pairs(screens) do + for i = 1, #screens, 2 do + local line = screens[i] local screen_name = line:match("^(.-) connected") if screen_name then - local max_res = line:match(" (%d+x%d+)") + local max_res = screens[i + 1]:match("(%d+x%d+)") if max_res then awful.spawn.easy_async_with_shell("xrandr --output " .. screen_name .. " --mode " .. max_res, function() - -- save users setup for the future awful.spawn.easy_async_with_shell("autorandr --save " .. screen_name, function() naughty.notify({ title = "Automatic Display Configuration", text = "Applied and saved configuration for " .. screen_name }) end) end) - else -- default to auto detection if display can't be determined + else awful.spawn.easy_async_with_shell("autorandr --change", function() naughty.notify({ title = "Automatic Display Configuration", text = "Maximum resolution could not be determined for " .. screen_name .. ". Autodetected settings applied." }) end) @@ -62,5 +62,4 @@ awful.spawn.with_line_callback("stdbuf -oL udevadm monitor --property --subsyste end }) -return DetectMonitor - +return DetectMonitor \ No newline at end of file From 057014dbe21f3ab5ba6c1f9b2f459d0ffcd03eaa Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Thu, 5 Oct 2023 21:09:32 -0700 Subject: [PATCH 04/20] Removed PKGBUILD, cleaning up installer --- installer/PKGBUILD/PKGBUILD | 45 --------------------------- installer/PKGBUILD/rabbithole.install | 17 ---------- rabbithole/services/dropdown.lua | 4 +-- 3 files changed, 2 insertions(+), 64 deletions(-) delete mode 100644 installer/PKGBUILD/PKGBUILD delete mode 100644 installer/PKGBUILD/rabbithole.install diff --git a/installer/PKGBUILD/PKGBUILD b/installer/PKGBUILD/PKGBUILD deleted file mode 100644 index 8cece73..0000000 --- a/installer/PKGBUILD/PKGBUILD +++ /dev/null @@ -1,45 +0,0 @@ -# Maintainer: LycanDarko lycandarko (at) proton.me -pkgname="rabbithole" -pkgver=b0.8.1.r1 -pkgrel=1 -epoch= -pkgdesc="Rabbithole Meta-Window Manager. A extra-dimensional, lightning-fast UI made for enhancing productivity, a second brain interface. Built from the awesome window manager framework. GitHub Master branch." -arch=(x86_64) -url="https://github.com/SaintRyoh/rabbithole" -license=('GPL') -groups=() -depends=(awesome rofi autorandr picom ttf-ubuntu-font-family lxqt-policykit lxqt-powermanagement tmux volumeicon network-manager-applet blueman flameshot rofi-themes-collection-git beautyline linux-wifi-hotspot) -makedepends=(git) -checkdepends=() -optdepends=() -conflicts=(awesome-git) -install="rabbithole.install" -source=(rabbithole::git+$url.git#branch=DropdownContainer) -md5sums=('SKIP') - -prepare() { - cd "$pkgname" - git submodule update --init -} - -pkgver() { - cd "$srcdir/$pkgname" - git describe --long --abbrev=7 --tags | sed 's/\([^-]*\)-g.*/r\1/;s/-/./g' -} - -package() { - # Install the rabbithole config to /usr/share/rabbithole - install -dm755 "$pkgdir/usr/share/rabbithole" - cp -r "$srcdir/$pkgname/"* "$pkgdir/usr/share/rabbithole" - # Install the rabbithole.desktop to /usr/share/xsessions - install -Dm644 "$srcdir/$pkgname/installer/rabbithole.desktop" "$pkgdir/usr/share/xsessions/rabbithole.desktop" - # Install readme to /usr/share/doc/rabbithole - install -Dm644 "$srcdir/$pkgname/README.md" "$pkgdir/usr/share/doc/rabbithole" - echo "To use Rabbithole, copy the configuration to your ~/.config/ directory:" - echo "cp -r /usr/share/rabbithole ~/.config/" - echo "Log out and select Rabbithole from your display-manager login screen to begin using it." - echo "If you want the custom picom config:" - echo "cp /usr/share/rabbithole/installer/picom.conf ~/.config/picom/picom.conf" - echo "Don't forget to set your rofi theme with the rofi-theme-selector when you log in!" - echo "Please report any bugs or check out our Discord. All the information is on GitHub https://github.com/SaintRyoh/rabbithole" -} diff --git a/installer/PKGBUILD/rabbithole.install b/installer/PKGBUILD/rabbithole.install deleted file mode 100644 index 289b024..0000000 --- a/installer/PKGBUILD/rabbithole.install +++ /dev/null @@ -1,17 +0,0 @@ -post_install() { - echo "To use Rabbithole, copy the configuration to your ~/.config/ directory:" - echo "cp -r /usr/share/rabbithole ~/.config/" - echo "Log out and select Rabbithole from your display-manager login screen to begin using it." - echo "If you want the custom picom config:" - echo "cp /usr/share/rabbithole/installer/picom.conf ~/.config/picom/picom.conf" - echo "Don't forget to set your rofi theme with the rofi-theme-selector when you log in!" - echo "Please report any bugs or check out our Discord. All the information is on GitHub https://github.com/SaintRyoh/rabbithole" -} - -post_remove() { - echo "Removing Rabbithole configuration from /usr/share..." - rm -rf /usr/share/rabbithole - echo "Rabbithole configuration removed from /usr/share." - rm -rf /usr/share/doc/rabbithole - echo "Rabbithole has been fully removed from your system (your configuration is still in your home directory). Tell us why you left on GitHub? -} diff --git a/rabbithole/services/dropdown.lua b/rabbithole/services/dropdown.lua index b4db873..68e2830 100644 --- a/rabbithole/services/dropdown.lua +++ b/rabbithole/services/dropdown.lua @@ -9,7 +9,7 @@ local function outCubic(t, b, c, d) return c * (t * t * t + 1) + b end --- Dropdown application container widget + local Dropdown = {} function Dropdown:new(config) @@ -69,7 +69,7 @@ function Dropdown:display() }) return end - + -- Dropdown rules client.floating = true client.border_width = self.border From f60f8e9d257d1f2d35d9d80a36a596569236e158 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Thu, 5 Oct 2023 22:03:11 -0700 Subject: [PATCH 05/20] Improving the AUR package --- installer/rabbithole | 2 ++ installer/rabbithole.desktop | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 installer/rabbithole diff --git a/installer/rabbithole b/installer/rabbithole new file mode 100644 index 0000000..e87f371 --- /dev/null +++ b/installer/rabbithole @@ -0,0 +1,2 @@ +#!/bin/bash +exec awesome -c "$HOME/.config/rabbithole/rc.lua" diff --git a/installer/rabbithole.desktop b/installer/rabbithole.desktop index 2cfb761..d88bb9a 100644 --- a/installer/rabbithole.desktop +++ b/installer/rabbithole.desktop @@ -2,5 +2,5 @@ Encoding=UTF-8 Name=Rabbithole Comment=Rabbithole Meta-Window Manager -Exec=/usr/bin/awesome +Exec=/usr/bin/rabbithole Type=XSession From 9f3694fef14819263d6c0ee0473746e2cc72e817 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Thu, 5 Oct 2023 23:14:15 -0700 Subject: [PATCH 06/20] AUR package should be a one liner now --- installer/rabbithole | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/installer/rabbithole b/installer/rabbithole index e87f371..3cd44da 100644 --- a/installer/rabbithole +++ b/installer/rabbithole @@ -1,2 +1,19 @@ #!/bin/bash -exec awesome -c "$HOME/.config/rabbithole/rc.lua" + +config_dir="$HOME/.config/awesome" +rabbithole_config_dir="$config_dir/rabbithole" + +if [ -d "$rabbithole_config_dir" ]; then + echo "Rabbithole configuration already installed. Starting Awesome WM..." +else + if [ ! -d "$config_dir" ]; then + echo "Creating $config_dir directory..." + mkdir -p "$config_dir" + fi + + echo "Copying Rabbithole configuration to $config_dir..." + cp -r /usr/share/rabbithole/* "$config_dir" + echo "Rabbithole configuration has been copied to $config_dir." +fi + +exec /usr/bin/awesome From 09e90a3e213150856dcdfd4ecf9bf7179f22f15a Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Fri, 6 Oct 2023 15:33:06 -0700 Subject: [PATCH 07/20] README.md updated for LxQt --- README.md | 126 +++++++----------------------------- docs/README-Installation.md | 87 +++++++++++++++++++++++++ 2 files changed, 111 insertions(+), 102 deletions(-) create mode 100644 docs/README-Installation.md diff --git a/README.md b/README.md index 8e28ee6..5090d42 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # Rabbithole—The Meta-Window Manager ### LOOKING FOR BETA TESTERS -**Now available in the AUR** Automated Installer Working for Arch and Ubuntu Linux - Please Help Us Test On Other Distros -We need people to test the installation procedure and give us feedback before we start major promotion. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole! +**Package now available in the AUR** `yay -S rabbithole`, then select Rabbithole from your display manager when you log in! + +There is also an automated installer `rabid-installer.sh` working for Arch and Ubuntu Linux - Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole! ### Discord Support -Join our group on [Rabbithole's Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) for **live support** and to talk to the developers! We're happy to help with anything you need, we are looking for feature requests, feedback, or even help with customizing your installation! We also love to talk about philosophy, AI, and the future of computing. Come join us! +Join our group on [Rabbithole's Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) for **live support** and to talk to the developers! We're happy to help with anything you need, we are looking for feature requests, feedback, and offer guided-assistance for the installation if you need it. We also love to talk about some pretty meta stuff, so, come join us! ### **Basic Usage Tutorial:** The Windows key on your keyboard has magical powers. -i3 users will notice the keybindings are very familiar. +i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions. - **Hit ```Win + s``` to see Rabbithole's help and keybindings page.** - ```Win + d``` will open the program launcher. @@ -67,7 +68,7 @@ _Video demonstration when you click on the image below._ - [The Vision of Rabbithole (Planned Features)](#the-vision-of-rabbithole-planned-features) ## About Rabbithole -A _revolutionary_ window manager that takes productivity to a _**whole new dimension**_ (quite literally). Rabbithole is not just another window manager—it is a dynamic, fluid, and interactive environment that challenges conventional paradigms of window management. It breathes life into your workspace and transforms the way you interact with your computer. +A _revolutionary_ kind of window manager that takes productivity to a _**whole new dimension**_ (quite literally). Rabbithole is not just another window manager—it is a dynamic, fluid, and interactive environment that challenges conventional paradigms of what a WM is for. It breathes life into your workspace and transforms the way you interact with your computer. It can also act as a full drop-in replacement for the window manager of your favorite Desktop Environment (DE) and reap all of the combined benefits. Built on the robust **Awesome WM framework**, Rabbithole embraces the philosophy of dynamic workspaces. It allows you to nest virtual workspaces and add or remove displays on-the-fly. With Rabbithole, you don't adjust to your workspace, your workspace adjusts to _you_. @@ -108,21 +109,26 @@ Rabbithole is ideal for users who: ## Installation -**Rabbithole is now available in the AUR** with `yay -S rabbithole` +**Rabbithole is now available in the AUR** with `yay -S rabbithole`. No extra steps needeed, just select **Rabbithole** from your display manager/login screen. + +If you want to install Rabbithole manually, or with the automated `rabid-installer.sh`, because the AUR package isn't feasible, please follow our [Installation Guide](docs/README-Installation.md) ### Prerequisites Rabbithole is designed for use on Linux operating systems. To use Rabbithole, you should: - Have a working Linux installation. Rabbithole has been [tested](#looking-for-beta-testers) and is known to work on: Arch, Garuda, Ubuntu, Kali. -- Be comfortable using the command line, as some aspects of the installation process may require it. -- Have **git** installed to clone the Rabbithole repository. If you don't have git installed, you can install it with your distribution's package manager. For example, on Ubuntu, you can install git with the following command: ```sudo apt install git``` -- For the DE-Like experience, yay or another AUR tool should be installed on Arch based distros for the easiest installation. +- Have **git** installed. If you don't have git installed, you can install it with your distribution's package manager. For example, on Ubuntu, you can install git with the following command: ```sudo apt install git``` +- Have an AUR package helper installed, if you are on an Arch system (unless you use the rabid-installer) + +## Dependencies ### Core Packages Only (Advanced Users) -These are the dependencies you need if you are going to manually install all of your systray programs and really know what you are doing when it comes to window managers. Only recommended for experienced users who want to build their environment themselves. You will still have to go through [post installation](#post-installation) to configure Rabbithole properly. +These are the dependencies you need if you are going to manually install all of your systray programs and really know what you are doing when it comes to window managers. Only recommended for experienced users who want to build their environment themselves manually. You will still have to go through [post installation](#post-installation) to configure Rabbithole properly. + ``` +lxqt awesome rofi rofi-themes-collection-git @@ -134,6 +140,7 @@ tmux ``` ### DE-Like Experience Packages (Recommended) ``` +lxqt awesome rofi rofi-themes-collection-git @@ -151,104 +158,19 @@ linux-wifi-hotspot tmux ``` -## Tutorial -Here are instructions on how to get Rabbithole up-and-running. -**Note:** If you wish to use Rabbithole as a drop-in window manager replacement for a Desktop Environment, please see the [LxQt tutorial](docs/README-lxqt-installation.md) and then proceed to [Install Rabbithole](#3-install-rabbithole) - -**Rabbithole can be installed easily from the AUR** -`yay -S rabbithole` - -Then copy your configuration to the appropriate place: -```bash -cp /usr/share/rabbithole ~/.config/awesome -``` -Please let us know if you have any issues with the AUR package.We need to know if it works on others systems. - -### Automated Installer (Recommended) - -The automated installer will not only install all of the dependencies, but it will copy all custom Rabbithole configurations (picom, rofi, etc.) to their appropriate locations. If you already have a copy of Rabbithole installed, the installer will not delete your settings.lua. So if you messed up your installation, you should `rm -rf ~/.config/awesome` before proceeding. -**Note:** Running the automated installer means you can skip the rest of the tutorial. Dive straight into selecting Rabbithole from your login screen and boot it up! - -```shell -git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init -chmod +x rabid-installer.sh -./rabid-installer.sh -``` -Then select Rabbithole from your display manager (login screen)! -![Rabbithole](docs/install_images/1-select-rabbithole.jpeg) -**Note:** We need beta testers for systems other than Arch-based so we can make sure the installer works. Please contact us! - -### Manual Installation -If you don't want to use the installer script and prefer doing things by hand, a full DE-like install for Arch will be shown below (yay must be installed). -#### 1) Clone Repo & Initialize Submodules -```shell -git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init -``` -#### 2) Install Dependencies -``` -yay -S awesome rofi rofi-themes-collection-git picom autorandr ttf-ubuntu-font-family volumeicon beautyline lxqt-policykit lxqt-powermanagement network-manager-applet blueman-git flameshot linux-wifi-hotspot -``` -Installing Rabbithole for other distros works as well, or you can use our [automated-installer](#automated-installer) and let us know if it works or not, so we can get it running on all major distros. The installer supports; Debian, Arch, Void, & Gentoo (as well as distros based on the aforementioned ones). - -#### 3) Install Rabbitole - -Simply copy or symlink the config to your Awesome WM configuration directory after initializing the submodules: -```shell -cp -R rabbithole/* ~/.config/awesome -``` -Or make a symlink -``` -ln -s rabbithole ~/.config/awesome -``` -### Post Installation -After Rabbithole is now installed, we sill must configure everything. -#### 4) Configuration -Next, you will need to copy the configuration for picom and Rabbithole's settings to their appropriate places. -```picom -cp rabbithole/installer/picom.conf ~/.config/picom.conf -``` -Then copy settings.lua for **core**: -``` -cp rabbithole/installer/settings-core.lua ~/.config/awesome/settings.lua -``` -Or the full **DE-like** installation: -``` -cp rabbithole/installer/settings-full.lua ~/.config/awesome/settings.lua -``` -Manually edit the settings.lua if you desire to use other software. - -Rofi themes collection and Ubuntu Font Family installation remain the same across distributions: +If you choose to install package-by-package manually, follow the same [post installation steps](docs/README-Installation.md#post-installation) in the automated installation procedure. -#### 5) Clone the Rofi themes collection: -```bash -mkdir -p "$HOME/.local/share/rofi/themes" -git clone https://github.com/newmanls/rofi-themes-collection.git "$HOME/.local/share/rofi/themes" -``` -#### 6) Install the Ubuntu Font Family Manually (not necessary on Arch or Ubuntu): -```bash -sudo mkdir -p "/usr/share/fonts/ubuntu-font-family" -sudo wget -O "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" https://assets.ubuntu.com/v1/fad7939b-ubuntu-font-family-0.83.zip -sudo unzip "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" -d "/usr/share/fonts/ubuntu-font-family -``` -#### Install BeautyLine Icon Pack -``` -git clone https://github.com/Tekh-ops/Garuda-Linux-Icons.git "/usr/share/icons/BeautyLine" -``` -#### 7) Update icon cache: -``` -gtk-update-icon-cache -f -t /usr/share/icons/BeautyLine -``` -Repeat the same [post installation steps](#post-installation) in the automated installation procedure. ## Configuring Rabbithole Rabbithole's configuration file is located in ```~/.config/awesome/settings.lua```. When you want to change anything about Rabbithole, this is the place you go. You should never have to modify Rabbithole's source code. As new features are added, they will have their options added to settings.lua. -Here you can add startup programs and daemons to the list under the appropraite tables. (Tutorials coming soon) +Here you can add startup programs and daemons to the list under the appropraite tables. (Tutorial for settings.lua coming soon, as well as a GUI for it.) + ### Contributing -We are looking for contributors to join the team. Right now we have accomplished a lot between two extremely tight-knit engineers, with the same vision, and complimentary programming (with 15 years of pair-programming experience). We are looking for others who fit (or can be molded)! +We are looking for contributors to join the team. Right now we have accomplished a lot between two extremely tight-knit engineers with the same vision, and complementary programming (with 15 years of pair-programming experience). We are looking for others who sharte our vision (or can be molded)! What is our vision, you ask? -### The Vision of Rabbithole (Planned Features) +### The Vision of Rabbithole Rabbithole is more than just software—it's a journey into the future of digital spaces, and we have the roadmap charted out. It's a long one. @@ -256,9 +178,9 @@ With our current version to 1.x, we have crafted a promising open beta and v1 as As we finish up the remainder of unfinished features for v1 (and the bugs that undoubtedly come with it), we plan to immediately progress to version 2.x. We have already identified a host of enhancements and features we want to incorporate. We love Awesome WM, but its incompatibility with Wayland and the bugs laden within picom have motivated us to push the boundaries, because we have pushed AWM near its limitations. Even though X isn't disappearing anytime soon, we are setting our sights towards the future of Virtual Reality (VR) and Augmented Reality (AR) interfaces. We have a few options in front of us. But this will likely require programming an entirely new framework from the ground up, or continuing where others have left off. We are open to ideas. -Our grand vision is to morph Rabbithole into an AI-powered virtual interface that offers full compatibility with all of your devices. Be it your mobile, PC, or VR/AR headsets, we aim to provide a seamless, unified, and immersive experience across all platforms. +Our grand vision is to morph Rabbithole into an AI-powered virtual interface that offers full compatibility with all of your devices. Be it your mobile, PC, or VR/AR headsets, we aim to provide a seamless, unified, and immersive experience across all platforms. We are already feeling concrete about the next framework to build Rabbithole v2.x with. -#### About the "Building A Second Brain" and "Getting Things Done" concepts that fit into Rabbithole's philosophy: +#### About Rabbithole's Philosophy of Being a Second-Brain Interface _"Building a Second Brain"_ and _"Getting Things Done"_ (GTD) are two significant productivity philosophies that Rabbithole integrates at its core. diff --git a/docs/README-Installation.md b/docs/README-Installation.md new file mode 100644 index 0000000..6f29fb0 --- /dev/null +++ b/docs/README-Installation.md @@ -0,0 +1,87 @@ +## Tutorial +Here are instructions on how to get Rabbithole up-and-running. +**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md) and then proceed to [Install Rabbithole](#3-install-rabbithole). If you want to install Rabbithole as just a window manager (dynamic displays not yet full supported), then follow the [Manual Installation](#manual-installation) instructions. + +**Rabbithole can be installed easily from the AUR** +`yay -S rabbithole` + +Then copy your configuration to the appropriate place: +```bash +cp /usr/share/rabbithole ~/.config/awesome +``` +Please let us know if you have any issues with the AUR package.We need to know if it works on others systems. You can also try the Automated installer + +### Automated Installer (Recommended) + +The automated installer will not only install all of the dependencies, but it will copy all custom Rabbithole configurations (picom, rofi, etc.) to their appropriate locations. If you already have a copy of Rabbithole installed, the installer will not delete your settings.lua. So if you messed up your installation, you should `rm -rf ~/.config/awesome` before proceeding. +**Note:** Running the automated installer means you can skip the rest of the tutorial. Dive straight into selecting Rabbithole from your login screen and boot it up! + +```shell +git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init +chmod +x rabid-installer.sh +./rabid-installer.sh +``` +Then select Rabbithole from your display manager (login screen)! +![Rabbithole](docs/install_images/1-select-rabbithole.jpeg) +**Note:** We need beta testers for systems other than Arch-based so we can make sure the installer works. Please contact us! + +### Manual Installation +If you don't want to use the installer script and prefer doing things by hand, a full DE-like install for Arch will be shown below (yay must be installed). +#### 1) Clone Repo & Initialize Submodules +```shell +git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init +``` +#### 2) Install Dependencies +``` +yay -S awesome rofi rofi-themes-collection-git picom autorandr ttf-ubuntu-font-family volumeicon beautyline lxqt-policykit lxqt-powermanagement network-manager-applet blueman-git flameshot linux-wifi-hotspot +``` +Installing Rabbithole for other distros works as well, or you can use our [automated-installer](#automated-installer) and let us know if it works or not, so we can get it running on all major distros. The installer supports; Debian, Arch, Void, & Gentoo (as well as distros based on the aforementioned ones). + +#### 3) Install Rabbitole + +Simply copy or symlink the config to your Awesome WM configuration directory after initializing the submodules: +```shell +cp -R rabbithole/* ~/.config/awesome +``` +Or make a symlink +``` +ln -s rabbithole ~/.config/awesome +``` +### Post Installation +After Rabbithole is now installed, we sill must configure everything. +#### 4) Configuration +Next, you will need to copy the configuration for picom and Rabbithole's settings to their appropriate places. +```picom +cp rabbithole/installer/picom.conf ~/.config/picom.conf +``` +Then copy settings.lua for **core**: +``` +cp rabbithole/installer/settings-core.lua ~/.config/awesome/settings.lua +``` +Or the full **DE-like** installation: +``` +cp rabbithole/installer/settings-full.lua ~/.config/awesome/settings.lua +``` +Manually edit the settings.lua if you desire to use other software. + +Rofi themes collection and Ubuntu Font Family installation remain the same across distributions: + +#### 5) Clone the Rofi themes collection: +```bash +mkdir -p "$HOME/.local/share/rofi/themes" +git clone https://github.com/newmanls/rofi-themes-collection.git "$HOME/.local/share/rofi/themes" +``` +#### 6) Install the Ubuntu Font Family Manually (not necessary on Arch or Ubuntu): +```bash +sudo mkdir -p "/usr/share/fonts/ubuntu-font-family" +sudo wget -O "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" https://assets.ubuntu.com/v1/fad7939b-ubuntu-font-family-0.83.zip +sudo unzip "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" -d "/usr/share/fonts/ubuntu-font-family +``` +#### Install BeautyLine Icon Pack +``` +git clone https://github.com/Tekh-ops/Garuda-Linux-Icons.git "/usr/share/icons/BeautyLine" +``` +#### 7) Update icon cache: +``` +gtk-update-icon-cache -f -t /usr/share/icons/BeautyLine +``` \ No newline at end of file From 141eab7f6cf821cb937754a94ee0a909a8573daa Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Fri, 6 Oct 2023 15:43:19 -0700 Subject: [PATCH 08/20] Style fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5090d42..890b93d 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Join our group on [Rabbithole's Discord](https://discord.com/channels/112234804 ### **Basic Usage Tutorial:** The Windows key on your keyboard has magical powers. -i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions. +i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions! -- **Hit ```Win + s``` to see Rabbithole's help and keybindings page.** +- **Hit ```Win + h``` to see Rabbithole's help and keybindings page.** - ```Win + d``` will open the program launcher. - ```Win + Tab``` will open your window/task switcher. - ```Win + f``` will fullscreen your workspace switcher. From fccc208c2ff4d02fe9de15a93e4d9227b0b60f03 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Fri, 6 Oct 2023 15:50:59 -0700 Subject: [PATCH 09/20] Fine-tuning installation procedure --- README.md | 12 +++++++----- docs/README-Installation.md | 1 - 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 890b93d..6822729 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,11 @@ _Video demonstration when you click on the image below._ - [Ideal For](#ideal-for) - [Installation](#installation) - [Prerequisites](#prerequisites) - - [Dependencies](#core-packages-only-advanced-users) - - [Tutorial](#tutorial) - - [Automated Installer](#automated-installer-recommended) - - [Manual Installation](#manual-installation) -- [Post Installation](#post-installation) + - [Dependencies](#dependencies) + - [Tutorial](docs/README-Installation.md#tutorial) + - [Automated Installer](docs/README-Installation.md#automated-installer-recommended) + - [Manual Installation](docs/README-Installation.md#manual-installation) +- [Post Installation](docs/README-Installation.md#post-installation) - [Configuring Rabbithole](#configuring-rabbithole) - [Contributing](#contributing) - [The Vision of Rabbithole (Planned Features)](#the-vision-of-rabbithole-planned-features) @@ -111,6 +111,8 @@ Rabbithole is ideal for users who: **Rabbithole is now available in the AUR** with `yay -S rabbithole`. No extra steps needeed, just select **Rabbithole** from your display manager/login screen. +**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md). If you want to install Rabbithole as a standalone window manager (dynamic displays not yet fully supported), then follow the [Manual Installation](#manual-installation) instructions. + If you want to install Rabbithole manually, or with the automated `rabid-installer.sh`, because the AUR package isn't feasible, please follow our [Installation Guide](docs/README-Installation.md) ### Prerequisites diff --git a/docs/README-Installation.md b/docs/README-Installation.md index 6f29fb0..ef7238e 100644 --- a/docs/README-Installation.md +++ b/docs/README-Installation.md @@ -1,6 +1,5 @@ ## Tutorial Here are instructions on how to get Rabbithole up-and-running. -**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md) and then proceed to [Install Rabbithole](#3-install-rabbithole). If you want to install Rabbithole as just a window manager (dynamic displays not yet full supported), then follow the [Manual Installation](#manual-installation) instructions. **Rabbithole can be installed easily from the AUR** `yay -S rabbithole` From 50d6d9118826a05f1f3f0cff1234697f390d8225 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Fri, 6 Oct 2023 15:51:47 -0700 Subject: [PATCH 10/20] Fixed broken link in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6822729..123d81c 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ Rabbithole is ideal for users who: **Rabbithole is now available in the AUR** with `yay -S rabbithole`. No extra steps needeed, just select **Rabbithole** from your display manager/login screen. -**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md). If you want to install Rabbithole as a standalone window manager (dynamic displays not yet fully supported), then follow the [Manual Installation](#manual-installation) instructions. +**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md). If you want to install Rabbithole as a standalone window manager (dynamic displays not yet fully supported), then follow the [Manual Installation](docs/README-Installation.md#manual-installation) instructions. If you want to install Rabbithole manually, or with the automated `rabid-installer.sh`, because the AUR package isn't feasible, please follow our [Installation Guide](docs/README-Installation.md) From d0620fb04eefc378eedea932ecee378635e2fac0 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Fri, 6 Oct 2023 16:07:34 -0700 Subject: [PATCH 11/20] Stylistic and readability improvements. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 123d81c..1a4122c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Rabbithole—The Meta-Window Manager ### LOOKING FOR BETA TESTERS -**Package now available in the AUR** `yay -S rabbithole`, then select Rabbithole from your display manager when you log in! +**Package now available in the AUR** +```shell +yay -S rabbithole +``` + +Then select Rabbithole from your display manager next time you log in. There is also an automated installer `rabid-installer.sh` working for Arch and Ubuntu Linux - Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole! @@ -8,7 +13,8 @@ There is also an automated installer `rabid-installer.sh` working for Arch and U Join our group on [Rabbithole's Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) for **live support** and to talk to the developers! We're happy to help with anything you need, we are looking for feature requests, feedback, and offer guided-assistance for the installation if you need it. We also love to talk about some pretty meta stuff, so, come join us! -### **Basic Usage Tutorial:** The Windows key on your keyboard has magical powers. +### Rabbithole Basic Usage Tutorial +**The Windows key on your keyboard has magical powers.** i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions! - **Hit ```Win + h``` to see Rabbithole's help and keybindings page.** From 11e920f52238225779b464c2738abb6e308277c5 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Mon, 9 Oct 2023 15:13:47 -0700 Subject: [PATCH 12/20] Improved README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1a4122c..05cee17 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Rabbithole—The Meta-Window Manager -### LOOKING FOR BETA TESTERS -**Package now available in the AUR** + +## Package now available in the AUR ```shell yay -S rabbithole ``` -Then select Rabbithole from your display manager next time you log in. +Then select **Rabbithole** from your display manager next time you log in. There is also an automated installer `rabid-installer.sh` working for Arch and Ubuntu Linux - Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole! @@ -14,14 +14,17 @@ Join our group on [Rabbithole's Discord](https://discord.com/channels/112234804 ### Rabbithole Basic Usage Tutorial + **The Windows key on your keyboard has magical powers.** -i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions! -- **Hit ```Win + h``` to see Rabbithole's help and keybindings page.** +i3 users will notice the keybindings are very familiar. Non-i3 users, the controls are as intuitive as possible. _If you don't like the controls, let us know, and we can vote on better defaults. We are open to suggestions!_ + +- ```Win + h``` to see Rabbithole's help and keybindings page. - ```Win + d``` will open the program launcher. - ```Win + Tab``` will open your window/task switcher. - ```Win + f``` will fullscreen your workspace switcher. - ```Win + q``` will kill the focused app. + #### **Mouse** - Left click and hold on client icons in the tasklist to drag and drop clients from one tag to another - Right-click tasks to move them between local or global tags and workspaces. @@ -37,14 +40,14 @@ i3 users will notice the keybindings are very familiar. Non-i3 users, the contro - [x] Dozens of minor UI enhancements, leading to a much more polished and fluid experience - [x] Rabbithole is now available in the AUR with `yay -S rabbithole` - [x] (In Progress) YouTube tutorial video (install, usage, etc.) -- [x] Improved dynamic display management. Now you can switch between an aribtrary amount of multi-monitor setups, and Rabbithole automatically detects your previous configuration and appies it. +- [x] Improved dynamic display management. Now you can switch between an aribtrary amount of multi-monitor setups, and Rabbithole automatically detects your previous configuration and applies it. - [x] Many bugfixes ### Upcoming Features -- [x] Automatic seamless session saving (this one's almost done! 24-hours, max) +- [x] Automatic, seamless session saving and restoration - [x] Obsidian integration - [x] Toggleable menubars with options to hide/show on mouse movement' -- [x] A unified appearance to the interface across low and hi-dpi monitors. Bypassing X11's limitaton of one DPI for all screens, and giving every Rabbithole user and identical experience +- [x] A unified appearance to the interface across low and hi-dpi monitors. Bypassing X11's limitaton of one DPI for all screens, and giving every Rabbithole user an identical experience - [x] Custom systray - [x] Advanced Notification Center - [x] (Optional) side-saddle titlebars (we're getting rid of the "Nice" library) @@ -178,7 +181,7 @@ We are looking for contributors to join the team. Right now we have accomplished What is our vision, you ask? -### The Vision of Rabbithole +### Rabbithole Manifesto Rabbithole is more than just software—it's a journey into the future of digital spaces, and we have the roadmap charted out. It's a long one. From dbec5cbb33059342bbe01d858821ab61d769d6bc Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Mon, 9 Oct 2023 16:05:36 -0700 Subject: [PATCH 13/20] Added CONTRIBUTING.md --- README.md | 15 ++++++++------- docs/CONTRIBUTING.md | 4 ++++ 2 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index 05cee17..998e4ac 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Rabbithole—The Meta-Window Manager +Rabbithole is a revolutionary window manager built on the robust Awesome WM framework, designed to transform the way you interact with your computer. It features dynamic display management, a polished user interface, intuitive navigation, and personalization options to create a seamless, aesthetically pleasing workspace experience. + ## Package now available in the AUR ```shell yay -S rabbithole @@ -134,10 +136,9 @@ Rabbithole is designed for use on Linux operating systems. To use Rabbithole, yo ## Dependencies -### Core Packages Only (Advanced Users) - These are the dependencies you need if you are going to manually install all of your systray programs and really know what you are doing when it comes to window managers. Only recommended for experienced users who want to build their environment themselves manually. You will still have to go through [post installation](#post-installation) to configure Rabbithole properly. +### Core Packages Only (Advanced Users) ``` lxqt awesome @@ -169,19 +170,19 @@ linux-wifi-hotspot tmux ``` -If you choose to install package-by-package manually, follow the same [post installation steps](docs/README-Installation.md#post-installation) in the automated installation procedure. +If you choose to install package-by-package manually, read the [post installation steps](docs/README-Installation.md#post-installation) ## Configuring Rabbithole Rabbithole's configuration file is located in ```~/.config/awesome/settings.lua```. When you want to change anything about Rabbithole, this is the place you go. You should never have to modify Rabbithole's source code. As new features are added, they will have their options added to settings.lua. -Here you can add startup programs and daemons to the list under the appropraite tables. (Tutorial for settings.lua coming soon, as well as a GUI for it.) +Here you can add startup programs and daemons to the list under the appropraite tables. (Tutorial for settings.lua coming soon, as well as a GUI for it.) We are developing a graphical settings manager for ease of use. -### Contributing +## Contributing -We are looking for contributors to join the team. Right now we have accomplished a lot between two extremely tight-knit engineers with the same vision, and complementary programming (with 15 years of pair-programming experience). We are looking for others who sharte our vision (or can be molded)! +We welcome contributors to join our team if you share our vision for Rabbithole. check out our [contributing guidelines](LINK-TO-CONTRIBUTING.md) and [open issues](https://github.com/USERNAME/REPO/issues) to get started. What is our vision, you ask? -### Rabbithole Manifesto +## Rabbithole Manifesto Rabbithole is more than just software—it's a journey into the future of digital spaces, and we have the roadmap charted out. It's a long one. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..2aa3bf7 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,4 @@ +## Contributing to Rabbithole +If you want to contribute to Rabbithole, please join the Rabbithole [Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) and get to know us. + +We are a tight-knit pair of two programmers right now who have been pair-programming for over 15 years, so we are looking for hand-in-glove fits who know what the projects logical conclusion and vision is and can help us get there. Don't be shy, though! We are very friendly and open to new ideas and new people. \ No newline at end of file From c1d454325ca48db5ea00ba6478a52e4296c78f85 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Mon, 9 Oct 2023 17:01:55 -0700 Subject: [PATCH 14/20] Heavily revised README & install tutorial. --- README.md | 78 ++++++++----------------- docs/README-Installation.md | 112 +++++++++++++++++++++++++++++------- 2 files changed, 117 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 998e4ac..de05a54 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,21 @@ Rabbithole is a revolutionary window manager built on the robust Awesome WM framework, designed to transform the way you interact with your computer. It features dynamic display management, a polished user interface, intuitive navigation, and personalization options to create a seamless, aesthetically pleasing workspace experience. -## Package now available in the AUR +## Rabbithole Now Available in the AUR ```shell yay -S rabbithole ``` +If you aren't running an Arch-based distro, use one of the installation methods below. -Then select **Rabbithole** from your display manager next time you log in. +1) [Automated install](docs/README-Installation.md#automated-installer) that works for Arch, Ubuntu, & Kali (also expected to work on distros based on these). -There is also an automated installer `rabid-installer.sh` working for Arch and Ubuntu Linux - Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole! +2) [Manual install](docs/README-Installation.md#manual-installation) Rabbithole on any distro that runs LxQt and Awesome WM. + +**Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole!** ### Discord Support -Join our group on [Rabbithole's Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) for **live support** and to talk to the developers! We're happy to help with anything you need, we are looking for feature requests, feedback, and offer guided-assistance for the installation if you need it. We also love to talk about some pretty meta stuff, so, come join us! +Join our group on [Rabbithole's Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) for **live support** and to talk to the developers! We're happy to help with anything you need, we are looking for feature requests, feedback, and offer guided-assistance for the installation if you need it. We also love to talk about some pretty meta stuff, so, come join us! ### Rabbithole Basic Usage Tutorial @@ -63,18 +66,15 @@ _Video demonstration when you click on the image below._ [![Watch the video demo!](docs/install_images/Rabbithole_Screenshot.png)](https://youtu.be/ci8KCli6YFQ) ## Table of Contents -- [About](#about) +- [About](#about-rabbithole) - [What is a Meta-Window Manager?](#what-is-a-meta-window-manager) - [Features](#features) - [Ideal For](#ideal-for) - [Installation](#installation) - - [Prerequisites](#prerequisites) - - [Dependencies](#dependencies) - - [Tutorial](docs/README-Installation.md#tutorial) + - [Tutorial](docs/README-Installation.md#rabbit-hole-installation-tutorial) - [Automated Installer](docs/README-Installation.md#automated-installer-recommended) - [Manual Installation](docs/README-Installation.md#manual-installation) -- [Post Installation](docs/README-Installation.md#post-installation) -- [Configuring Rabbithole](#configuring-rabbithole) + - [Post Installation](docs/README-Installation.md#post-installation) - [Contributing](#contributing) - [The Vision of Rabbithole (Planned Features)](#the-vision-of-rabbithole-planned-features) @@ -120,60 +120,32 @@ Rabbithole is ideal for users who: ## Installation -**Rabbithole is now available in the AUR** with `yay -S rabbithole`. No extra steps needeed, just select **Rabbithole** from your display manager/login screen. +There are different ways to install Rabbithole depending on your needs. The current, full-featured and recommended installtion setup is **Rabbithole as a drop-in window manager replacement for _LxQt_**. -**Note:** The current supported method to install Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md). If you want to install Rabbithole as a standalone window manager (dynamic displays not yet fully supported), then follow the [Manual Installation](docs/README-Installation.md#manual-installation) instructions. +To install Rabbithole as a drop-in window manager replacement for LxQt, follow the instructions below: -If you want to install Rabbithole manually, or with the automated `rabid-installer.sh`, because the AUR package isn't feasible, please follow our [Installation Guide](docs/README-Installation.md) +- If you are a beginner, we recommend using the AUR package, or the [automated installer](docs/README-Installation.md#automated-installer-recommended). +- If you are an experienced user, you can [install Rabbithole manually](docs/README-Installation.md#manual-installation). +- Then, follow the [LxQt Tutorial](docs/README-lxqt-installation.md) to being running Rabbithole. -### Prerequisites +### Rabbithole AUR Installation -Rabbithole is designed for use on Linux operating systems. To use Rabbithole, you should: +```shell +yay -S rabbithole +``` -- Have a working Linux installation. Rabbithole has been [tested](#looking-for-beta-testers) and is known to work on: Arch, Garuda, Ubuntu, Kali. -- Have **git** installed. If you don't have git installed, you can install it with your distribution's package manager. For example, on Ubuntu, you can install git with the following command: ```sudo apt install git``` -- Have an AUR package helper installed, if you are on an Arch system (unless you use the rabid-installer) +No extra steps needeed, just select **Rabbithole** from your display manager/login screen. -## Dependencies +### Full-Featured Installation -These are the dependencies you need if you are going to manually install all of your systray programs and really know what you are doing when it comes to window managers. Only recommended for experienced users who want to build their environment themselves manually. You will still have to go through [post installation](#post-installation) to configure Rabbithole properly. +**The current supported and full-featured way of running Rabbithole is as a drop-in window manager replacement for a LxQt, please see the [LxQt tutorial](docs/README-lxqt-installation.md).** -### Core Packages Only (Advanced Users) -``` -lxqt -awesome -rofi -rofi-themes-collection-git -picom -autorandr -ttf-ubuntu-font-family -beautyline -tmux -``` -### DE-Like Experience Packages (Recommended) -``` -lxqt -awesome -rofi -rofi-themes-collection-git -picom -autorandr -ttf-ubuntu-font-family -beautyline -volumeicon -lxqt-policykit -lxqt-powermanagement -network-manager-applet -blueman-git -flameshot -linux-wifi-hotspot -tmux -``` +If you want to install Rabbithole as a standalone window manager (dynamic display management is buggy in pure Lua), then follow the [Manual Installation](docs/README-Installation.md#manual-installation) instructions. -If you choose to install package-by-package manually, read the [post installation steps](docs/README-Installation.md#post-installation) +If you want to install Rabbithole manually, or with the automated `rabid-installer.sh`, because the AUR package isn't feasible, please follow our [Installation Guide](docs/README-Installation.md) ## Configuring Rabbithole -Rabbithole's configuration file is located in ```~/.config/awesome/settings.lua```. When you want to change anything about Rabbithole, this is the place you go. You should never have to modify Rabbithole's source code. As new features are added, they will have their options added to settings.lua. +Rabbithole's configuration file is located in `~/.config/awesome/settings.lua`. When you want to change anything about Rabbithole, this is the place you go. You should never have to modify Rabbithole's source code. As new features are added, they will have their options added to settings.lua. Here you can add startup programs and daemons to the list under the appropraite tables. (Tutorial for settings.lua coming soon, as well as a GUI for it.) We are developing a graphical settings manager for ease of use. ## Contributing diff --git a/docs/README-Installation.md b/docs/README-Installation.md index ef7238e..4b18020 100644 --- a/docs/README-Installation.md +++ b/docs/README-Installation.md @@ -1,36 +1,92 @@ -## Tutorial +# Rabbithole Installation Tutorial Here are instructions on how to get Rabbithole up-and-running. -**Rabbithole can be installed easily from the AUR** -`yay -S rabbithole` +## Arch Linux AUR Installation +```shell +yay -S rabbithole +``` + +Then copy or symlink Rabbithole's configuration to the `~/.config/awesome` directory: -Then copy your configuration to the appropriate place: ```bash cp /usr/share/rabbithole ~/.config/awesome ``` -Please let us know if you have any issues with the AUR package.We need to know if it works on others systems. You can also try the Automated installer +Or +```bash +ln -s /usr/share/rabbithole ~/.config/awesome +``` + +Finally, [set up to use Rabbithole with LxQt](README-lxqt-installation.md), or select Rabbithole from your display manager (login screen)! + -### Automated Installer (Recommended) +Let us know if you have any [issues](https://github.com/SaintRyoh/rabbithole/issues) with the AUR package. -The automated installer will not only install all of the dependencies, but it will copy all custom Rabbithole configurations (picom, rofi, etc.) to their appropriate locations. If you already have a copy of Rabbithole installed, the installer will not delete your settings.lua. So if you messed up your installation, you should `rm -rf ~/.config/awesome` before proceeding. -**Note:** Running the automated installer means you can skip the rest of the tutorial. Dive straight into selecting Rabbithole from your login screen and boot it up! +## Automated Installer (Recommended for Novice Users) +The automated installer will install all of Rabbithole's dependencies and copy all custom Rabbithole configurations (picom, rofi, etc.) to their appropriate locations. After that, just [set up LxQt](README-lxqt-installation.md). +**Note** If you already have a copy of Rabbithole installed, the installer will not delete your settings.lua. So if you messed up your installation, you should `rm -rf ~/.config/awesome` before proceeding. + +### Steps ```shell git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init +``` +Make installer executable and run it: +```shell chmod +x rabid-installer.sh +``` +```shell ./rabid-installer.sh ``` -Then select Rabbithole from your display manager (login screen)! -![Rabbithole](docs/install_images/1-select-rabbithole.jpeg) -**Note:** We need beta testers for systems other than Arch-based so we can make sure the installer works. Please contact us! -### Manual Installation +Then [set up LxQt](README-lxqt-installation.md), or select Rabbithole from your display manager (login screen). +![Rabbithole](install_images/1-select-rabbithole.jpeg) + +## Manual Installation (Advanced Users) + +Below are the dependencies you need if you are going to manually install all of your systray programs and really know what you are doing when it comes to window managers. Only recommended for experienced users who want to build their environment themselves manually. You will still have to go through [post installation](#post-installation) to configure Rabbithole properly. + +### Core Packages +``` +lxqt +awesome +rofi +rofi-themes-collection-git +picom +autorandr +ttf-ubuntu-font-family +beautyline +tmux +``` +### DE-Like Experience Packages +``` +lxqt +awesome +rofi +rofi-themes-collection-git +picom +autorandr +ttf-ubuntu-font-family +beautyline +volumeicon +lxqt-policykit +lxqt-powermanagement +network-manager-applet +blueman-git +flameshot +linux-wifi-hotspot +tmux +``` + If you don't want to use the installer script and prefer doing things by hand, a full DE-like install for Arch will be shown below (yay must be installed). + #### 1) Clone Repo & Initialize Submodules + ```shell git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init ``` + #### 2) Install Dependencies + ``` yay -S awesome rofi rofi-themes-collection-git picom autorandr ttf-ubuntu-font-family volumeicon beautyline lxqt-policykit lxqt-powermanagement network-manager-applet blueman-git flameshot linux-wifi-hotspot ``` @@ -39,48 +95,64 @@ Installing Rabbithole for other distros works as well, or you can use our [autom #### 3) Install Rabbitole Simply copy or symlink the config to your Awesome WM configuration directory after initializing the submodules: + ```shell cp -R rabbithole/* ~/.config/awesome ``` + Or make a symlink -``` + +```shell ln -s rabbithole ~/.config/awesome ``` + ### Post Installation + After Rabbithole is now installed, we sill must configure everything. + #### 4) Configuration + Next, you will need to copy the configuration for picom and Rabbithole's settings to their appropriate places. -```picom + +```shell cp rabbithole/installer/picom.conf ~/.config/picom.conf ``` -Then copy settings.lua for **core**: -``` + +For a basic, minimal installation (for advanced users) copy settings.lua for **core**: + +```shell cp rabbithole/installer/settings-core.lua ~/.config/awesome/settings.lua ``` + Or the full **DE-like** installation: -``` + +```shell cp rabbithole/installer/settings-full.lua ~/.config/awesome/settings.lua ``` -Manually edit the settings.lua if you desire to use other software. Rofi themes collection and Ubuntu Font Family installation remain the same across distributions: #### 5) Clone the Rofi themes collection: + ```bash mkdir -p "$HOME/.local/share/rofi/themes" git clone https://github.com/newmanls/rofi-themes-collection.git "$HOME/.local/share/rofi/themes" ``` + #### 6) Install the Ubuntu Font Family Manually (not necessary on Arch or Ubuntu): + ```bash sudo mkdir -p "/usr/share/fonts/ubuntu-font-family" sudo wget -O "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" https://assets.ubuntu.com/v1/fad7939b-ubuntu-font-family-0.83.zip sudo unzip "/usr/share/fonts/ubuntu-font-family/Ubuntu.zip" -d "/usr/share/fonts/ubuntu-font-family ``` + #### Install BeautyLine Icon Pack -``` +```shell git clone https://github.com/Tekh-ops/Garuda-Linux-Icons.git "/usr/share/icons/BeautyLine" ``` + #### 7) Update icon cache: -``` +```shell gtk-update-icon-cache -f -t /usr/share/icons/BeautyLine ``` \ No newline at end of file From a33aef2698d8cbe9d2a03a1e5ae860dccde0602d Mon Sep 17 00:00:00 2001 From: LycanDarko <122252200+LycanDarko666@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:05:45 -0700 Subject: [PATCH 15/20] Delete .vscode directory --- .vscode/easycode.ignore | 16 ---------------- .vscode/extensions.json | 6 ------ .vscode/settings.json | 11 ----------- 3 files changed, 33 deletions(-) delete mode 100644 .vscode/easycode.ignore delete mode 100644 .vscode/extensions.json delete mode 100644 .vscode/settings.json diff --git a/.vscode/easycode.ignore b/.vscode/easycode.ignore deleted file mode 100644 index 78d5f95..0000000 --- a/.vscode/easycode.ignore +++ /dev/null @@ -1,16 +0,0 @@ -node_modules/ -dist/ -vendor/ -cache/ -.*/ -*.min.* -*.test.* -*.spec.* -*.bundle.* -*.bundle-min.* -*.*.js -*.*.ts -*.log -docs/ -installer/ -lua_modules/ \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index e894844..0000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "recommendations": [ - "sumneko.lua", - "yinfei.luahelper" - ] -} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 7a6098b..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "Lua.diagnostics.globals": [ - "RC", - "screen", - "root", - "awesome", - "client", - "mouse", - ], - "vim.foldfix": true -} \ No newline at end of file From 2a02585191a1d2e1a90b9b15cc62dc7c7fd6a815 Mon Sep 17 00:00:00 2001 From: LycanDarko <122252200+LycanDarko666@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:06:01 -0700 Subject: [PATCH 16/20] Delete .SRCINFO --- .SRCINFO | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 .SRCINFO diff --git a/.SRCINFO b/.SRCINFO deleted file mode 100644 index 32f6e1c..0000000 --- a/.SRCINFO +++ /dev/null @@ -1,26 +0,0 @@ -pkgbase = rabbithole - pkgdesc = Rabbithole—The Meta-Window Manager. Built from the awesome window manager framework. - pkgver = 0.8.0 - pkgrel = 1 - url = https://github.com/SaintRyoh/rabbithole - arch = x86_64 - license = GPL - depends = awesome - depends = rofi - depends = autorandr - depends = picom - depends = ttf-ubuntu-font-family - depends = lxqt-policykit - depends = lxqt-powermanagement - depends = tmux - depends = volumeicon - depends = network-manager-applet - depends = blueman - depends = flameshot - depends = rofi-themes-collection-git - depends = beautyline - depends = linux-wifi-hotspot - source = rabbithole::git+https://github.com/SaintRyoh/rabbithole.git - sha256sums = SKIP - -pkgname = rabbithole From 0eb3ea088069daca05e1753f6d421eec5789f81e Mon Sep 17 00:00:00 2001 From: LycanDarko <122252200+LycanDarko666@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:11:50 -0700 Subject: [PATCH 17/20] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 9a837a262058f8c7a106fa79903fb6bd17e6732b Mon Sep 17 00:00:00 2001 From: LycanDarko <122252200+LycanDarko666@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:12:11 -0700 Subject: [PATCH 18/20] Delete docs/LICENSE --- docs/LICENSE | 675 --------------------------------------------------- 1 file changed, 675 deletions(-) delete mode 100644 docs/LICENSE diff --git a/docs/LICENSE b/docs/LICENSE deleted file mode 100644 index 496acdb..0000000 --- a/docs/LICENSE +++ /dev/null @@ -1,675 +0,0 @@ -# GNU GENERAL PUBLIC LICENSE - -Version 3, 29 June 2007 - -Copyright (C) 2007 Free Software Foundation, Inc. - - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - -## Preamble - -The GNU General Public License is a free, copyleft license for -software and other kinds of works. - -The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom -to share and change all versions of a program--to make sure it remains -free software for all its users. We, the Free Software Foundation, use -the GNU General Public License for most of our software; it applies -also to any other work released this way by its authors. You can apply -it to your programs, too. - -When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - -To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you -have certain responsibilities if you distribute copies of the -software, or if you modify it: responsibilities to respect the freedom -of others. - -For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - -Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - -For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - -Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the -manufacturer can do so. This is fundamentally incompatible with the -aim of protecting users' freedom to change the software. The -systematic pattern of such abuse occurs in the area of products for -individuals to use, which is precisely where it is most unacceptable. -Therefore, we have designed this version of the GPL to prohibit the -practice for those products. If such problems arise substantially in -other domains, we stand ready to extend this provision to those -domains in future versions of the GPL, as needed to protect the -freedom of users. - -Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish -to avoid the special danger that patents applied to a free program -could make it effectively proprietary. To prevent this, the GPL -assures that patents cannot be used to render the program non-free. - -The precise terms and conditions for copying, distribution and -modification follow. - -## TERMS AND CONDITIONS - -### 0. Definitions. - -"This License" refers to version 3 of the GNU General Public License. - -"Copyright" also means copyright-like laws that apply to other kinds -of works, such as semiconductor masks. - -"The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - -To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of -an exact copy. The resulting work is called a "modified version" of -the earlier work or a work "based on" the earlier work. - -A "covered work" means either the unmodified Program or a work based -on the Program. - -To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - -To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user -through a computer network, with no transfer of a copy, is not -conveying. - -An interactive user interface displays "Appropriate Legal Notices" to -the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -### 1. Source Code. - -The "source code" for a work means the preferred form of the work for -making modifications to it. "Object code" means any non-source form of -a work. - -A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - -The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - -The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - -The Corresponding Source need not include anything that users can -regenerate automatically from other parts of the Corresponding Source. - -The Corresponding Source for a work in source code form is that same -work. - -### 2. Basic Permissions. - -All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - -You may make, run and propagate covered works that you do not convey, -without conditions so long as your license otherwise remains in force. -You may convey covered works to others for the sole purpose of having -them make modifications exclusively for you, or provide you with -facilities for running those works, provided that you comply with the -terms of this License in conveying all material for which you do not -control copyright. Those thus making or running the covered works for -you must do so exclusively on your behalf, under your direction and -control, on terms that prohibit them from making any copies of your -copyrighted material outside their relationship with you. - -Conveying under any other circumstances is permitted solely under the -conditions stated below. Sublicensing is not allowed; section 10 makes -it unnecessary. - -### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - -No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - -When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such -circumvention is effected by exercising rights under this License with -respect to the covered work, and you disclaim any intention to limit -operation or modification of the work as a means of enforcing, against -the work's users, your or third parties' legal rights to forbid -circumvention of technological measures. - -### 4. Conveying Verbatim Copies. - -You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -### 5. Conveying Modified Source Versions. - -You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these -conditions: - -- a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. -- b) The work must carry prominent notices stating that it is - released under this License and any conditions added under - section 7. This requirement modifies the requirement in section 4 - to "keep intact all notices". -- c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. -- d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - -A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -### 6. Conveying Non-Source Forms. - -You may convey a covered work in object code form under the terms of -sections 4 and 5, provided that you also convey the machine-readable -Corresponding Source under the terms of this License, in one of these -ways: - -- a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. -- b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the Corresponding - Source from a network server at no charge. -- c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. -- d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. -- e) Convey the object code using peer-to-peer transmission, - provided you inform other peers where the object code and - Corresponding Source of the work are being offered to the general - public at no charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - -A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, -family, or household purposes, or (2) anything designed or sold for -incorporation into a dwelling. In determining whether a product is a -consumer product, doubtful cases shall be resolved in favor of -coverage. For a particular product received by a particular user, -"normally used" refers to a typical or common use of that class of -product, regardless of the status of the particular user or of the way -in which the particular user actually uses, or expects or is expected -to use, the product. A product is a consumer product regardless of -whether the product has substantial commercial, industrial or -non-consumer uses, unless such uses represent the only significant -mode of use of the product. - -"Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to -install and execute modified versions of a covered work in that User -Product from a modified version of its Corresponding Source. The -information must suffice to ensure that the continued functioning of -the modified object code is in no case prevented or interfered with -solely because modification has been made. - -If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - -The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or -updates for a work that has been modified or installed by the -recipient, or for the User Product in which it has been modified or -installed. Access to a network may be denied when the modification -itself materially and adversely affects the operation of the network -or violates the rules and protocols for communication across the -network. - -Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -### 7. Additional Terms. - -"Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders -of that material) supplement the terms of this License with terms: - -- a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or -- b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or -- c) Prohibiting misrepresentation of the origin of that material, - or requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or -- d) Limiting the use for publicity purposes of names of licensors - or authors of the material; or -- e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or -- f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions - of it) with contractual assumptions of liability to the recipient, - for any liability that these contractual assumptions directly - impose on those licensors and authors. - -All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - -Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; the -above requirements apply either way. - -### 8. Termination. - -You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -### 9. Acceptance Not Required for Having Copies. - -You are not required to accept this License in order to receive or run -a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -### 10. Automatic Licensing of Downstream Recipients. - -Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - -An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - -You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -### 11. Patents. - -A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - -A contributor's "essential patent claims" are all patent claims owned -or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - -Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - -In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - -If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - -A patent license is "discriminatory" if it does not include within the -scope of its coverage, prohibits the exercise of, or is conditioned on -the non-exercise of one or more of the rights that are specifically -granted under this License. You may not convey a covered work if you -are a party to an arrangement with a third party that is in the -business of distributing software, under which you make payment to the -third party based on the extent of your activity of conveying the -work, and under which the third party grants, to any of the parties -who would receive the covered work from you, a discriminatory patent -license (a) in connection with copies of the covered work conveyed by -you (or copies made from those copies), or (b) primarily for and in -connection with specific products or compilations that contain the -covered work, unless you entered into that arrangement, or that patent -license was granted, prior to 28 March 2007. - -Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -### 12. No Surrender of Others' Freedom. - -If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under -this License and any other pertinent obligations, then as a -consequence you may not convey it at all. For example, if you agree to -terms that obligate you to collect a royalty for further conveying -from those to whom you convey the Program, the only way you could -satisfy both those terms and this License would be to refrain entirely -from conveying the Program. - -### 13. Use with the GNU Affero General Public License. - -Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - -### 14. Revised Versions of this License. - -The Free Software Foundation may publish revised and/or new versions -of the GNU General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies that a certain numbered version of the GNU General Public -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that numbered version or -of any later version published by the Free Software Foundation. If the -Program does not specify a version number of the GNU General Public -License, you may choose any version ever published by the Free -Software Foundation. - -If the Program specifies that a proxy can decide which future versions -of the GNU General Public License can be used, that proxy's public -statement of acceptance of a version permanently authorizes you to -choose that version for the Program. - -Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -### 15. Disclaimer of Warranty. - -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT -WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE -DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR -CORRECTION. - -### 16. Limitation of Liability. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR -CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES -ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT -NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR -LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM -TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER -PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -### 17. Interpretation of Sections 15 and 16. - -If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - -END OF TERMS AND CONDITIONS - -## How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively state -the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper -mail. - -If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands \`show w' and \`show c' should show the -appropriate parts of the General Public License. Of course, your -program's commands might be different; for a GUI interface, you would -use an "about box". - -You should also get your employer (if you work as a programmer) or -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. For more information on this, and how to apply and follow -the GNU GPL, see . - -The GNU General Public License does not permit incorporating your -program into proprietary programs. If your program is a subroutine -library, you may consider it more useful to permit linking proprietary -applications with the library. If this is what you want to do, use the -GNU Lesser General Public License instead of this License. But first, -please read . From 121c2e578b04794c0bd3d7ade578299972b3a5a0 Mon Sep 17 00:00:00 2001 From: LycanDarko <122252200+LycanDarko666@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:14:32 -0700 Subject: [PATCH 19/20] Create CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9cd58d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +## Contributing to Rabbithole +If you want to contribute to Rabbithole, please join the Rabbithole [Discord](https://discord.com/channels/1122348043950366823/1122348044382392432) and get to know us. + +We are a tight-knit pair of two programmers right now who have been pair-programming for over 15 years, so we are looking for hand-in-glove fits who know what the projects logical conclusion and vision is and can help us get there. Don't be shy, though! We are very friendly and open to new ideas and new people. From 7479c8784e1dfa4a91ae10a7b95dbe908f346229 Mon Sep 17 00:00:00 2001 From: LycanDarko Date: Tue, 10 Oct 2023 23:47:21 -0700 Subject: [PATCH 20/20] Final revision. Moving onto titlebars. --- README.md | 24 +++++++++++++++++++----- docs/README-Installation.md | 29 +++++++++++++++++++++++------ 2 files changed, 42 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index de05a54..529f69f 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,29 @@ Rabbithole is a revolutionary window manager built on the robust Awesome WM framework, designed to transform the way you interact with your computer. It features dynamic display management, a polished user interface, intuitive navigation, and personalization options to create a seamless, aesthetically pleasing workspace experience. -## Rabbithole Now Available in the AUR +There are a few ways to install Rabbithole. work your way down, and pick only one. + +## Installation (Recommended for Every System) +Make sure you have `lxqt`, `git`, and `awesome` installed. Then do the following in a terminal: + ```shell -yay -S rabbithole +git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init +``` + +Copy or symlink Rabbithole's configuration to the `~/.config/awesome` directory: + +```bash +cp -R rabbithole/* ~/.config/awesome ``` -If you aren't running an Arch-based distro, use one of the installation methods below. +Then head follow the instructions to use Rabbithole on LxQt [here](README-lxqt-installation.md). -1) [Automated install](docs/README-Installation.md#automated-installer) that works for Arch, Ubuntu, & Kali (also expected to work on distros based on these). +## Rabbithole Now Available in the AUR +```shell +yay -S rabbithole && cp -R /usr/share/rabbithole ~/.config/awesome +``` +**Rabbithole is in the AUR** -2) [Manual install](docs/README-Installation.md#manual-installation) Rabbithole on any distro that runs LxQt and Awesome WM. +Other installation methods can be found in our [Installation Guide](docs/README-Installation.md), including the [automated installer](docs/README-Installation.md#automated-installer-recommended-for-novice-users), and [manual installation](docs/README-Installation.md#manual-installation-advanced-users). **Please Help Us Test On Other Distros & systems if you can. Earn your spot as a [contributor](docs/CONTRIBUTORS.md) to Rabbithole!** diff --git a/docs/README-Installation.md b/docs/README-Installation.md index 4b18020..e92cf26 100644 --- a/docs/README-Installation.md +++ b/docs/README-Installation.md @@ -1,5 +1,26 @@ # Rabbithole Installation Tutorial -Here are instructions on how to get Rabbithole up-and-running. +Here are instructions on how to get Rabbithole up-and-running. Only pick on of the installation methods below. + +## Table of Contents +- [Cut & Dry Installation (Recommended for Every System)](#cut--dry-installation-recommended-for-every-system) +- [Arch Linux AUR Installation](#arch-linux-aur-installation) +- [Automated Installer (Recommended for Novice Users)](#automated-installer-recommended-for-novice-users) + - [Steps](#steps) +- [Manual Installation (Advanced Users)](#manual-installation-advanced-users) + +## Cut & Dry Installation (Recommended for Every System) +Make sure you have `lxqt`, `git`, and `awesome` from your package manager. Then do the following in a terminal: + +```shell +git clone https://github.com/SaintRyoh/rabbithole && cd rabbithole && git submodule update --init +``` + +Copy or symlink Rabbithole's configuration to the `~/.config/awesome` directory: + +```bash +cp -R rabbithole/* ~/.config/awesome +``` +Then head follow the instructions to use Rabbithole on LxQt [here](README-lxqt-installation.md). ## Arch Linux AUR Installation ```shell @@ -54,7 +75,6 @@ rofi-themes-collection-git picom autorandr ttf-ubuntu-font-family -beautyline tmux ``` ### DE-Like Experience Packages @@ -66,12 +86,9 @@ rofi-themes-collection-git picom autorandr ttf-ubuntu-font-family -beautyline volumeicon -lxqt-policykit -lxqt-powermanagement network-manager-applet -blueman-git +blueman flameshot linux-wifi-hotspot tmux