Skip to content

Commit

Permalink
docs: update README with YouTube video link and revised instructions
Browse files Browse the repository at this point in the history
- Replaced screenshot with a YouTube video link for demonstration.
- Updated installation instructions to reflect changes in script usage (setup.sh instead of install.sh).
- Added note about package lists and laptop-specific configurations.
- Adjusted keybinding details to include launcher and laptop configuration references.
  • Loading branch information
UmmItC committed Dec 6, 2024
1 parent 7f52b3e commit 65e5dd1
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This repository is dedicated to my Hyprland DWM Arch Linux configuration files.

![](./screenshot/2024-08-15-203404_hyprshot.png)
[Watch this video on YouTube](https://www.youtube.com/watch?v=sjeKlj8mTjE)

# Installation Instructions

Expand All @@ -15,19 +15,14 @@ To run the script:
3. Execute the script according to the provided instructions.

```shell
chmod +x ./install.sh
./install.sh
chmod +x ./setup.sh
./setup.sh
```

## Installation Script

The `./setup.sh` script helps with the fresh installation process and handles the git cloning of the repository. Alternatively, you can clone the repository manually and run `install.sh` directly.

The `install.sh` script performs the following actions:

1. Installs the packages required for my dotfiles.
2. Copies configuration files to `~/`, `~/.config`, for the `ly` display manager, to `/etc/ly` and wallpaper on `~/.wallpaper`

## For manual configuration:

Just Copy the necessary files you want to your configuration directory:
Expand All @@ -50,6 +45,8 @@ You can set up your system quickly without needing to clone or download the scri

Here's a list of the packages I used.

>Note: The list is not exhaustive, and I may have missed some packages. For a complete list, you can refer to the `./configs/hypr/hyprland/plugins.conf` file. and for the laptop configuration, you can refer to the `./configs/hypr/hyprland/laptop.conf` file.
| Module Type | Module Name | Package Manager |
|--------------------------|-----------------|-----------------|
| System Information | Fastfetch | Pacman |
Expand Down Expand Up @@ -84,13 +81,9 @@ Here's a list of the packages I used.
| Cursor Theme | Bibata | AUR |
| File Manager (TUI) | Yazi | Pacman |

### Additional Configuration

- **Steam**: To enhance download speeds, enable HTTP/2 and optimize download rates.

## Keybindings

The hotkeys for managing your windows and launching tools are configured in the Hyprland configuration file located at `./configs/hypr/hyprland.conf`.
The hotkeys for managing your windows and launching tools are configured in the Hyprland configuration file located at `./configs/hypr/hyprland/launcher.conf`. and for the laptop configuration, you can refer to the `./configs/hypr/hyprland/laptop.conf` file.

| Key Combination | Action |
|-------------------|----------------------------|
Expand Down

0 comments on commit 65e5dd1

Please sign in to comment.