aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 28 insertions, 13 deletions
diff --git a/README.md b/README.md
index 77443b6..193efbd 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,20 @@ Lightweight Desktop installer for Alpine Linux based on the suckless philosophy.
![Screenshot of dwm running on Alpine Linux](https://git.btxx.org/screenshots/alpine-suck.png)
-Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.). Ships with `ohmyzsh` and personal `vim` configs. Uses `qutebrowser` for default browser.
+Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.). Ships with `ohmyzsh` and my personal `vim` configs.
+
+## What You Get
+
+The Open Suck installer gives you the absolute barebones desktop experience:
+
+- `dwm` for window management
+- `ranger` for your file browser
+- `firefox` as your core web browser
+- `aerc` for your terminal-based mail client
+- `slock` for screen locking
+- `scrot`/`slop` for simple screenshot utilities
+- `feh` for your image/file viewing
+- `dunst` for notifications
## Downloading
@@ -12,7 +25,7 @@ Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.). Ships
2. Run `setup-alpine`
3. Run `setup-xorg-base`
4. [Enable community/edge/testing repos](https://wiki.alpinelinux.org/wiki/Repositories#Enabling_the_community_repository)
-5. Install git, vim & doas
+5. Install git, vim & doas (doas is better than sudo!)
6. Edit doas permissions (`/etc/doas.conf`):
```
@@ -47,27 +60,29 @@ cd alpine-suck
## Installing
-1. Install dependencies by running `./install-dependencies.sh`
-2. Compile and install suckless software by running the `./install.sh`
+1. Install dependencies
+2. Compile and install suckless software
## TLDR
-```sh
-cd alpine-suck # CD into this repository
-doas sh ./install-dependencies.sh # Install alpine packages
-```
-
-Be sure to change the `$ALPINE_USER` variable to match that of your current
-user:
+**Warning**: Change the `$ALPINE_USER` variable inside `install-dependencies.sh` to match that of your current
+user.
```
$ALPINE_USER="bt"
```
-Then run the script to build suckless programs:
+Then continue...
+
+```sh
+cd alpine-suck # CD into this repository
+doas sh ./install-dependencies.sh # Install alpine packages
+```
+
+Give that some time. Once it is complete, run `install.sh` to build the suckless programs:
```sh
-doas sh ./install.sh # Install everything
+doas sh ./install.sh # Build & install everything
```
Reboot the machine. Log in as your main user. Run: