From f97ed3363556c9279d307397fad3c8645dbbb296 Mon Sep 17 00:00:00 2001 From: End Date: Sat, 20 Dec 2025 21:21:23 -0700 Subject: [PATCH] fix: quick pretty & fixes --- .github/pull_request_template.md | 2 +- docs/better-guide/part-1/content.html | 4 +- docs/better-guide/part-2/content.html | 182 ++++++++++---- docs/better-guide/part-3/content.html | 259 +++++++++++++++----- docs/gallery/index.html | 337 +++++++++++++------------- docs/index.html | 183 ++++++++------ 6 files changed, 607 insertions(+), 360 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cc62b39..23ebb3a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,7 +29,7 @@ - [ ] I have filled out the form correctly - [ ] I have my PR labeled correctly - [ ] I have not already submitted a rice -- [ ] Under the section where it states "How many hours did it take to write this:" I have a valid image link +- [ ] Under the section where it states "How many hours did it take to write this:" I have filled in my hours - [ ] i have my screenshot images in the json file (urls please). - [ ] i have my hackatime badge - - if you have errors finding it please put your slack ID instead!! diff --git a/docs/better-guide/part-1/content.html b/docs/better-guide/part-1/content.html index 95d68d6..4155633 100644 --- a/docs/better-guide/part-1/content.html +++ b/docs/better-guide/part-1/content.html @@ -217,6 +217,4 @@ LANG=en_US.UTF-8
# pacman -S bash-completion
 

Yippeee we now have a base system!

-

Click here to advance to the next session. -guide.html:199:29

- +

Click here to advance to the next session.

diff --git a/docs/better-guide/part-2/content.html b/docs/better-guide/part-2/content.html index f7428e3..8a94543 100644 --- a/docs/better-guide/part-2/content.html +++ b/docs/better-guide/part-2/content.html @@ -1,34 +1,68 @@

Installing additional packages

-

In this guide, I have chosen to install base Arch Linux. The following guide will assume that you are using Arch, but any Arch derivative should be able to follow the following guides too.

-

Also, a reminder that I have opinions, so these packages may not be the best for you :3

-

You can find alternatives here, here and just searching!

-
ℹ️ IMPORTANT

Note: Commands prefixed with # should be run as root, and those prefixed with $ should be run unprivileged.
To run something as root, use sudo <command>. If for some reason this doesn't work, try sudo -E <command> and finally try su to get a root shell
Lines prefixed with // are comments and should NOT be run.

+

+ In this guide, I have chosen to install base Arch Linux. The following guide + will assume that you are using Arch, but any Arch derivative should be able + to follow the following guides too. +

+

+ Also, a reminder that I have opinions, so these packages may not be the best + for you :3 +

+

+ You can find alternatives + here, + here and + just searching! +

+
+ ℹ️ IMPORTANT
+

+ Note: Commands prefixed with # should be run as root, and + those prefixed with $ should be run unprivileged.
To + run something as root, use sudo <command>. If for + some reason this doesn't work, try + sudo -E <command> and finally try su to + get a root shell
Lines prefixed with // are comments + and should NOT be run. +

-

Desktop Environment

-

Well, we have Linux, but all you see is a black console??

+

Well, we have Linux, but all you see is a black console??

We need to install a desktop environment and/or a compositor!

-

I have opted to use niri, why? Because it's written in rust and looks nice :3

-
# sudo pacman -Syu niri xwayland-satellite xdg-desktop-portal-gnome xdg-desktop-portal-gtk 
+

+ I have opted to use niri, why? + Because it's written in rust and looks nice :3 +

+
# sudo pacman -Syu niri xwayland-satellite xdg-desktop-portal-gnome xdg-desktop-portal-gtk
 
-

See configuration options here

-

Note that using a complete desktop environment like KDE plasma or GNOME will make setup much easier, but may restrict what you can rice.

+

+ See configuration options here +

+

+ Note that using a complete desktop environment like KDE plasma or GNOME will + make setup much easier, but may restrict what you can rice. +

KDE Plasma:

-
# pacman -S plasma
+
# pacman -S plasma
 

Gnome:

-
# pacman -S gnome
+
# pacman -S gnome
 

Greeter

-

Without a greeter, you'd have to use the ugly console to log in all the time.

+

+ Without a greeter, you'd have to use the ugly console to log in all the + time. +

I choose sddm as a greeter.

-
# sudo pacman -S sddm
+
# sudo pacman -S sddm
 

AUR helper

This simplifies using the AUR a lot!

I choose to use yay:

-
# pacman -S base-devel
+
# pacman -S base-devel
 $ git clone https://aur.archlinux.org/yay.git
 $ cd yay
 $ makepkg
@@ -36,93 +70,141 @@ $ makepkg
 

File Manager

I persoanlly use thunar, but it isn't very riceable ;-;

-
# pacman -S thunar
+
# pacman -S thunar
 

Browser

I use zen-browser

-
$ yay -S zen-browser
+
$ yay -S zen-browser
 // or
 $ yay -S zen-browser-bin
 
-

Zen documentation can be found here

+

+ Zen documentation can be found + here +

Zen can be riced using userChrome.css!

Code Editor

I use Zed:

-
# pacman -S zed
+
# pacman -S zed
 

Zed documentation can be found here

-

If you reallyyyy want to use vscode, see Arch wiki here

-

You can find other IDEs/editors here

+

+ If you reallyyyy want to use vscode, see Arch wiki + here +

+

+ You can find other IDEs/editors + here +

Hackatime

With Zed:

    -
  1. Ctrl+Shift+P
  2. -
  3. Search for zed: extensions
  4. -
  5. Search for wakatime
  6. -
  7. Install!
  8. +
  9. Ctrl+Shift+P
  10. +
  11. Search for zed: extensions
  12. +
  13. Search for wakatime
  14. +
  15. Install!

Terminal Emulator

I like kitty, but I've heard that Hack Club is sponsoring ghostty!

-
# pacman -S kitty
+
# pacman -S kitty
 // or
 # pacman -S ghostty
 
-

Kitty docs can be found here

+

+ Kitty docs can be found + here +

Ghostty docs can be found here

Video Player

mpv is a lightweight video player:

-
# pacman -S mpv
+
# pacman -S mpv
 

if you want, you can install VLC:

-
# pacman -S vlc
+
# pacman -S vlc
 

On Arch, VLC and its plugins are split. I would recommend:

-
# pacman -S vlc-plugins-all
+
# pacman -S vlc-plugins-all
 

Status Bar

-

If you like, there are widget frameworks that help you build cool bars and other widgets.

+

+ If you like, there are widget frameworks that help you build cool bars and + other widgets. +

This includes:

    -
  • ags (Configured in JavaScript, docs here) - $ yay -S aylurs-gtk-shell-git
  • -
  • Quickshell (Configured in QML, docs here) - $ yay -S quickshell
  • -
  • Fabric (Configured in Python, docs here) - $ yay -S python-fabric-git
  • +
  • + ags (Configured in JavaScript, docs + here) - + $ yay -S aylurs-gtk-shell-git +
  • +
  • + Quickshell (Configured in QML, docs + here) - + $ yay -S quickshell +
  • +
  • + Fabric (Configured in Python, docs + here) + - $ yay -S python-fabric-git +

If you only want a simple bar, I use waybar:

-
# pacman -S waybar
+
# pacman -S waybar
 
-

Waybar docs can be found here

+

+ Waybar docs can be found + here +

App Launcher

I use rofi:

-
# pacman -S rofi
+
# pacman -S rofi
 
-

Rofi docs can be found here

+

+ Rofi docs can be found here +

Clipboard

I use cliphist with wl-clipboard

-
# pacman -S cliphist
+
# pacman -S cliphist
 

Docs here

Screen Locker

I use hyprlock

-
# pacman -S hyprlock
+
# pacman -S hyprlock
 
-

hyprlock docs can be found here

+

+ hyprlock docs can be found + here +

System Monitor

I use btop, it runs in the terminal!

-
# pacman -S btop
+
# pacman -S btop
 

Docs can be found here

Color Palettes

-

If you like having color palettes that change with your wallpaper, try matugen or pywal:

-
$ yay -S matugen
+

+ If you like having color palettes that change with your wallpaper, try + matugen or pywal: +

+
$ yay -S matugen
 // or
 # pacman -S python-pywal
 
-

Matugen docs can be found here

+

+ Matugen docs can be found + here +

Wallpaper Picker

I use waypaper!

-
# pacman -S waypaper
+
# pacman -S waypaper
 
-

Waypaper docs can be found here

-

Now that we have a more complete system, reboot and continue to part 3 for the actual ricing! -guide.html:199:29

- +

+ Waypaper docs can be found + here +

+

+ Now that we have a more complete system, reboot and + continue to part 3 for the actual ricing! +

diff --git a/docs/better-guide/part-3/content.html b/docs/better-guide/part-3/content.html index 9571ed6..cfa5c0b 100644 --- a/docs/better-guide/part-3/content.html +++ b/docs/better-guide/part-3/content.html @@ -1,77 +1,155 @@

Ricing your desktop

What even is ricing?

-

(Stolen off some website) -"Ricing is a term that has been used in the computer and technology world to describe the act of customizing the appearance of Linux. The term originated from the practice of modifying a car’s appearance, specifically by adding decorative features such as spoilers or other embellishments to make it look more appealing. Ricing involves making changes to the user interface, icons, themes, fonts, and other visual elements of Linux to give it a unique and personalised look."

+

+ (Stolen off some website) "Ricing is a term that has been used in the + computer and technology world to describe the act of customizing the + appearance of Linux. The term originated from the practice of modifying a + car’s appearance, specifically by adding decorative features such as + spoilers or other embellishments to make it look more appealing. Ricing + involves making changes to the user interface, icons, themes, fonts, and + other visual elements of Linux to give it a unique and personalised + look." +

Getting Started

-

Because we are going to submit a git repo to riceathon, it's best to get organised before we start.

+

+ Because we are going to submit a git repo to riceathon, it's best to get + organised before we start. +

Create a new directory for your dotfiles:

-
mkdir -p ~/dotfiles
+
mkdir -p ~/dotfiles
 
-
ℹ️ IMPORTANT

What are dotfiles?
On linux, configuration files are usually stored in "dot"config (~/.config).
Dotfiles are these configuration files!

+
+ ℹ️ IMPORTANT
+

+ What are dotfiles?
On linux, configuration files + are usually stored in "dot"config (~/.config).
Dotfiles + are these configuration files! +

-

Create a GitHub repository: -img

-
cd ~/dotfiles
+

+ Create a GitHub repository: img +

+
cd ~/dotfiles
 git init
 git branch -M main
 git remote add origin github_url
 

Now, we've set up our folder.

-

Whenever we want to add a configuration folder to this github repo, we can create a symbolic link:

-
sln ~/.config/FOLDER_OR_FILE ~/dotfiles/FOLDER_OR_FILE
+

+ Whenever we want to add a configuration folder to this github repo, we can + create a symbolic link: +

+
sln ~/.config/FOLDER_OR_FILE ~/dotfiles/FOLDER_OR_FILE
 
-
ℹ️ IMPORTANT

What is a symbolic link?
A symbolic link (symlink) is a pointer to another file or folder.
So, if that file or folder changes, the symlinked contents also change!

+
+ ℹ️ IMPORTANT
+

+ What is a symbolic link?
A symbolic link (symlink) + is a pointer to another file or folder.
So, if that file or folder + changes, the symlinked contents also change! +

Ricing

-

When ricing, it is nice to set a color palette or a theme that you want to center your rice around.

-

Alternatively, you can try color palette generators - see matugen, or just go crazy!

-

If you want inspiration, you can visit r/unixporn, or look through my old dotfiles!

-

This guide will walk you through ricing a program that was installed in part 2, waybar :3

-

Our end result should look somewhat like this! -waybar

+

+ When ricing, it is nice to set a color palette or a theme that you want to + center your rice around. +

+

+ Alternatively, you can try color palette generators - see + matugen, + or just go crazy! +

+

+ If you want inspiration, you can visit + r/unixporn, or look through + my old dotfiles! +

+

+ This guide will walk you through ricing a program that was installed in part + 2, waybar :3 +

+

+ Our end result should look somewhat like this! + waybar +

Fonts

We've been using an ugly font this whole time ;-;

Lets spice it up!

-

The Arch wiki has a list of fonts here, browse through them or search for a fun font!

-

Personally, I use Maple Mono:

-
yay -S maplemononormal-nf-cn
+

+ The Arch wiki has a list of fonts + here, + browse through them or search for a fun font! +

+

+ Personally, I use + Maple Mono: +

+
yay -S maplemononormal-nf-cn
 

Also, install a Nerd Font for icons:

-
pacman -S nerd-font
+
pacman -S nerd-font
 
-

Pick your favourite! I use Jetbrains Mono (42) :3

+

Pick your favourite! I use Jetbrains Mono (42) :3

Waybar

-

Waybar docs can be found here!

+

+ Waybar docs can be found + here! +

Make sure waybar is installed:

-
pacman -S waybar
+
pacman -S waybar
 

Now, create the folders and files for waybar's config files:

-
mkdir -p ~/.config/waybar/{css,layouts}
+
mkdir -p ~/.config/waybar/{css,layouts}
 touch ~/.config/waybar/{config.jsonc,modules.jsonc,style.css}
 touch ~/.config/waybar/layouts/{with_music.jsonc,with_window.jsonc}
 touch ~/.config/waybar/css/{style.css,colors.css}
 
-
💡 TIP

What did we do?
mkdir creates a directory. The -p option makes it create intermediate paths too! touch is a command that creates a file.
Whenever we use the {}, syntax, we are using brace expansions:

-
-

"Brace expansions are a mechanism to generate arbitrary strings sharing a common prefix and suffix, either of which can be empty"
So:

-
-
echo a{d,c,b}e
+
+ 💡 TIP
+

+ What did we do?
mkdir creates a + directory. The -p option makes it create intermediate paths + too! touch is a command that creates a file.
Whenever + we use the {}, syntax, we are using + brace expansions: +

+
+

+ "Brace expansions are a mechanism to generate arbitrary strings + sharing a common prefix and suffix, either of which can be + empty"
So: +

+
+
echo a{d,c,b}e
 # RESULT: ade ace abe
 

Remember to symlink the waybar folder!

-
sln ~/.config/waybar ~/dotfiles/waybar
+
sln ~/.config/waybar ~/dotfiles/waybar
 
-

Now that we have our proper file layout, let's open our editor and do some coding :3

+

+ Now that we have our proper file layout, let's open our editor and do + some coding :3 +

To open Zed:

-
zeditor ~/.config/waybar
+
zeditor ~/.config/waybar
 

Make sure that Hackatime is working!

We've structured our waybar folder to be organised and modular:

-
~/.config/waybar/
+
~/.config/waybar/
 ├── config.jsonc
 ├── css
 │   ├── colors.css
@@ -83,17 +161,40 @@ touch ~/.config/waybar/css/{style.css,colors.css}
 └── style.css
 

Waybar has 2 files that must exist: config.jsonc, and style.css.

-

However, to make it easier to edit small things like modules or layout, we've separated out a modules.jsonc and a layouts folder.

-

Our top-level config.jsonc is simple, because all we do is import a layout. -Open the terminal from Zed (Ctrl + ~) and type:

-
echo '{ "include": [ "~/.config/waybar/layouts/with_music.jsonc" ] }' > config.jsonc
+

+ However, to make it easier to edit small things like modules or layout, + we've separated out a modules.jsonc and a + layouts folder. +

+

+ Our top-level config.jsonc is simple, because all we do is import a layout. + Open the terminal from Zed (Ctrl + ~) and type: +

+
echo '{ "include": [ "~/.config/waybar/layouts/with_music.jsonc" ] }' > config.jsonc
 
-
💡 TIP

What did we do?
> is a redirection operator. Here, we redirect the output of a command (echo) into a file (config.jsonc).

+
+ 💡 TIP
+

+ What did we do?
> is a redirection + operator. Here, we redirect the output of a command (echo) + into a file (config.jsonc). +

-

Next, lets make our modules. Open the modules.jsonc file in Zed.

-

Enter this in and look at the comments. Don't worry if the icons aren't visible on GitHub, as their font doesn't include the nerd font icons! Remember that you can customise things to suit you:

-
// You can find icons using the nerd font cheat sheet: https://nerdfonts.com/cheat_sheet
+

+ Next, lets make our modules. Open the modules.jsonc file in + Zed. +

+

+ Enter this in and look at the comments. Don't worry if the icons + aren't visible on GitHub, as their font doesn't include the nerd + font icons! Remember that you can customise things to suit you: +

+
// You can find icons using the nerd font cheat sheet: https://nerdfonts.com/cheat_sheet
 {
   // Shows our workspaces!
   "niri/workspaces": {
@@ -112,7 +213,7 @@ Open the terminal from Zed (Ctrl + ~) and type:

"niri/window": { "max-length": 45, }, - + // A module for monitoring cpu usage "cpu": { // Polling interval, in ms @@ -249,7 +350,7 @@ Open the terminal from Zed (Ctrl + ~) and type:

}, }, }, - + // mpris is a interface that lets programs poll playing media "mpris": { "format": "{artist} - {title}", @@ -275,7 +376,7 @@ Open the terminal from Zed (Ctrl + ~) and type:

Yippee! We finished our waybar modules!

Now it's time for the layout.

Open layouts/with_music.jsonc in Zed. Enter this:

-
{
+
{
   "layer": "bottom",
   "position": "top",
   "margin": "0 0 0 0",
@@ -310,8 +411,11 @@ Open the terminal from Zed (Ctrl + ~) and type:

"include": ["~/.config/waybar/modules.jsonc"], }
-

Done! Optionally, you can place this into layouts/with_window.jsonc:

-
{
+

+ Done! Optionally, you can place this into + layouts/with_window.jsonc: +

+
{
   "layer": "top",
   "position": "top",
   "width": 1920,
@@ -344,15 +448,26 @@ Open the terminal from Zed (Ctrl + ~) and type:

"include": ["~/.config/waybar/modules.jsonc"], }
-

Now that we've finished defining our layouts and modules, we can work on our styles.

-

Like config.jsonc, our top level style.css is a simple 1 line import:

-
echo '@import "css/style.css";' > style.css
+

+ Now that we've finished defining our layouts and modules, we can work on + our styles. +

+

+ Like config.jsonc, our top level style.css is a + simple 1 line import: +

+
echo '@import "css/style.css";' > style.css
 

Now we can run waybar and see our edits live!

-

In Zed, open css/colors.css. Here, we define our colour palette! Here are mine:

-
/* 
-Define your background, foreground, inactive colour 
-(Lowkey doesn't have a big difference 
+

+ In Zed, open css/colors.css. Here, we define our colour + palette! Here are mine: +

+
/*
+Define your background, foreground, inactive colour
+(Lowkey doesn't have a big difference
 */
 @define-color background rgba(20, 19, 24, 0.5);
 @define-color tooltip-bg @background;
@@ -367,8 +482,13 @@ Define your background, foreground, inactive colour
 @define-color yellow #c8c878;
 @define-color green #78c878;
 
-

Now, we can edit our styles. Open css/style.css in Zed and enter this:

-
/* Import our color palette */
+

+ Now, we can edit our styles. Open css/style.css in Zed and + enter this: +

+
/* Import our color palette */
 @import "colors.css";
 
 * {
@@ -555,16 +675,25 @@ menu > *:hover {
 

Make all your other programs look nice :3

This could include:

    -
  • Compositor
  • -
  • Terminal Emulator
  • -
  • App Launcher
  • -
  • etc!
  • +
  • Compositor
  • +
  • Terminal Emulator
  • +
  • App Launcher
  • +
  • etc!

Helpful Resources

    -
  • r/unixporn - This is the biggest online community for ricing! Go here for inspiration.
  • -
  • Arch Wiki - The Arch Linux wiki is incredibly helpful for everything related to Linux, with helpful information on tons of software.
  • -
  • awesome-ricing - A massive open-source list of ricing/Linux tools and software from window managers, to terminals, to colour schemes, to even wallpapers. -guide.html:199:29
  • +
  • + r/unixporn - This is + the biggest online community for ricing! Go here for inspiration. +
  • +
  • + Arch Wiki - The Arch Linux wiki + is incredibly helpful for everything related to Linux, with helpful + information on tons of software. +
  • +
  • + awesome-ricing + - A massive open-source list of ricing/Linux tools and software from + window managers, to terminals, to colour schemes, to even wallpapers. +
- diff --git a/docs/gallery/index.html b/docs/gallery/index.html index fca485b..e907b01 100644 --- a/docs/gallery/index.html +++ b/docs/gallery/index.html @@ -1,167 +1,170 @@ - - - - - - YSWS: socks - gallery - - - - - - - - - - - - - - - - - -
-

Gallery

-

Gallery of the {count} rice's

-
- - - - - - - \ No newline at end of file + + + + + YSWS: socks - gallery + + + + + + + + + + + + + + + + + +
+

Gallery

+

Gallery of the {count} rices

+
+ + + + + + diff --git a/docs/index.html b/docs/index.html index 87fa759..98e5f36 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,84 +1,119 @@ - + + + + Riceathon + + + + + + + + + - - - Riceathon - - - - - - - - - + + - - +
+ +

Riceathon

+

+ A Hack Club YSWS where you can rice your Linux desktop and + submit your dotfiles to get free programmer socks +

+ Start the Guide +
-
- -

Riceathon

-

A Hack Club YSWS where you can rice your Linux desktop and submit your dotfiles to get free - programmer socks

- Start the Guide -
- - -
-

- Run a Linux Distro on your Computer - or Laptop, spend some time spicing it up with customizations and recieve some cool swag to match your desktop. -

- -
+
-
-

So What is a Rice / Ricing?

-

- The term ‘rice’ is used to describe a person’s unix desktop where ‘ricing’ is when someone is customizing their - desktop such as the icons, panels, or system interface. When it comes to ricing a tiling window manager though, - the ricing of a user’s system becomes much more involved. Basic things such as the panel bar and application - launcher must be configured by the user. -

-
-

- See the basics of ricing here -

-
-
-

Where does your rice go?

-

- After you submit your rice it will be added to the gallery -

-
-
-

When does it end?

-

- V3 will end on TBD -

-
-
-

Ready to start?

+
+

So What is a Rice / Ricing?

+

+ The term ‘rice’ is used to describe a person’s unix desktop + where ‘ricing’ is when someone is customizing their desktop such + as the icons, panels, or system interface. When it comes to + ricing a tiling window manager though, the ricing of a user’s + system becomes much more involved. Basic things such as the + panel bar and application launcher must be configured by the + user. +

+
+

+ See the basics of ricing + here +

+
+
+

Where does your rice go?

+

+ After you submit your rice it will be added to the + gallery +

+
+
+

When does it end?

+

V3 will end on TBD

+
+
+

Ready to start?

-

- Set up Hakatime and start ricing using the editor of your choice! - Hakatime - will need to be set up with the same email as your Hack Club Slack account in order to count. You will need to - push your customization files to a Github repo once you're done. Afterward, submit a PR to the Riceathon repo with an update to the - members.json(check the formatting there for a template!) -

- -

Development chatter happens in the #riceathon channel in the Hack Club Slack.

-
- +

+ Set up + Hackatime and start + ricing using the editor of your choice! Hackatime will need to + be set up with the same email as your Hack Club Slack account in + order to count. You will need to push your customization files + to a Github repo once you're done. Afterward, + submit a PR + to the Riceathon repo with an update to the members.json(check + the formatting there for a template!) +

+

+ Development chatter happens in the + #riceathon + channel in the + Hack Club Slack. +

+
+