docs: Update README with installation instructions
This commit is contained in:
29
README.md
29
README.md
@@ -33,6 +33,35 @@ The primary goal was to enable reliable dark/light theme switching across Waybar
|
|||||||
6. **Hyprland Window Rules (`~/.config/hypr/UserConfigs/WindowRules.conf`)**:
|
6. **Hyprland Window Rules (`~/.config/hypr/UserConfigs/WindowRules.conf`)**:
|
||||||
* **Alacritty Opacity Fix:** Added a specific `windowrule = opacity 1.0 1.0, class:^(Alacritty)$` to ensure the Alacritty terminal is fully opaque. This overrides a more general `tag:terminal*` transparency rule that was unintentionally affecting Alacritty.
|
* **Alacritty Opacity Fix:** Added a specific `windowrule = opacity 1.0 1.0, class:^(Alacritty)$` to ensure the Alacritty terminal is fully opaque. This overrides a more general `tag:terminal*` transparency rule that was unintentionally affecting Alacritty.
|
||||||
|
|
||||||
|
## Installation 🚀
|
||||||
|
|
||||||
|
To install these dotfiles and set up your Hyprland environment, follow these steps:
|
||||||
|
|
||||||
|
1. **Clone the repository:**
|
||||||
|
```bash
|
||||||
|
git clone https://gitea.ramforth.net/ramforth/hyprland-dots.git ~/.config/hypr
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Navigate to the dotfiles directory:**
|
||||||
|
```bash
|
||||||
|
cd ~/.config/hypr
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Make the install script executable:**
|
||||||
|
```bash
|
||||||
|
chmod +x install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Run the installation script:**
|
||||||
|
```bash
|
||||||
|
./install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important Notes:**
|
||||||
|
* This script assumes you have already installed Hyprland and its core dependencies.
|
||||||
|
* You will need to manually install applications like Waybar, Kitty, etc., using your system's package manager (e.g., `pacman -S hyprland waybar kitty`).
|
||||||
|
* After running the script, it's recommended to reboot your system or log out and back in for all changes to take effect.
|
||||||
|
|
||||||
## Future Work
|
## Future Work
|
||||||
|
|
||||||
* **Firefox Theming:** Further investigation is needed to ensure Firefox correctly follows the dark/light theme switch managed by `DarkLight.sh`. This is likely related to how `DarkLight.sh` interacts with GTK themes and how Firefox interprets those changes.
|
* **Firefox Theming:** Further investigation is needed to ensure Firefox correctly follows the dark/light theme switch managed by `DarkLight.sh`. This is likely related to how `DarkLight.sh` interacts with GTK themes and how Firefox interprets those changes.
|
||||||
|
|||||||
Reference in New Issue
Block a user