aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md56
1 files changed, 22 insertions, 34 deletions
diff --git a/README.md b/README.md
index 4c9204c..0b0e58d 100644
--- a/README.md
+++ b/README.md
@@ -2,41 +2,38 @@
My personal suckless setup.
-- Rosé Pine color scheme and JetBrainsMono Nerd Font by default (colors from [Rosé Pine for st](https://github.com/rose-pine/st))
-- General purpose keybindings:
- - Alt+Shift+D: Opens Discord
- - Alt+Shift+F: Opens Firefox
- - PrtScr: Opens Flameshot
-
## Dependencies
+
Install necessary packages (Arch Linux specific, other distros will differ)
```sh
-sudo pacman -S picom feh flameshot ttf-jetbrains-mono-nerd libqalculate
+sudo pacman -S ttf-jetbrains-mono-nerd libqalculate
```
+It's also recommended to start dwm and other related software through xinit, my main [dotfiles repo](https://git.sr.ht/~pml68/dotfiles) contains the needed configurations.
+
+### Optional dependencies
+
+- `feh` and `picom`: for the wallpaper and compositing, respectively. The install script will detect their availability and install configurations accordingly.
+- `firefox`, `simplemoji`, `flameshot`, `discord`, `pulsemixer`, `adb`: some keybinds launch these programs.
+
## Installation
-### Manual
+### Automated
Clone the repo
```sh
git clone https://git.sr.ht/~pml68/suckless-setup
-cd suckless-setup/
+cd suckless-setup
```
-Replace config files
+Simply run the included script with root permissions.
```sh
-sudo cp picom.conf /etc/xdg/picom.conf
-
-# optional
-cp vis -r ~/.config/ # for https://github.com/dpayne/cli-visualizer
-
-git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
-cp tmux -r ~/.config
-
-# Start tmux, and install necessary plugins with C-a I
+chmod +x install
+sudo ./install
```
+### Manual
+
Build and install each suckless program
```sh
cd dwm
@@ -45,30 +42,21 @@ cd ..
cd dmenu
sudo make clean install
+cd ..
+
# ...
```
+#### Optional
+
Set the background
```sh
feh --bg-fill wallpaper.jpg
```
-Update your .xinitrc file
+Copy over the picom configuration
```sh
-# ...
-~/.fehbg &
-picom &
-flameshot &
-slstatus &
-exec dwm
-```
-
-### Automated
-
-Simply run the included script
-```sh
-chmod +x install.sh
-./install.sh
+sudo cp picom.conf /etc/xdg/picom.conf
```
# Screenshot: