aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 52 insertions, 19 deletions
diff --git a/README.md b/README.md
index 3d89f88..5bff921 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,21 @@
# Open Suck
-**Latest changes based off OpenBSD 7.5**
+**Latest changes based off OpenBSD 7.6**
-Lightweight Desktop installer for OpenBSD based on the suckless philosophy.
-Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.)
+* Lightweight Desktop installer for OpenBSD based on the suckless philosophy
+* Licensed under [Mixed](https://git.sr.ht/~bt/open-suck-installer/tree/LICENSE)
+* Discussion, patches etc. go to the
+ [list](https://lists.sr.ht/~bt/open-suck-devel)
-![Screenshot of dwm running on
-OpenBSD](https://git.sr.ht/~bt/open-suck-installer/blob/master/screenshot.png)
+---
+
+### Desktop Screenshot
+
+![Screenshot of dwm running on OpenBSD via desktop](/screenshots/open-suck-76.png)
+
+### Laptop Screenshot
+
+![Screenshot of dwm running on OpenBSD desktop](/screenshots/open-suck-75.png)
Successfully installed on:
@@ -21,7 +30,7 @@ The Open Suck installer gives you the absolute barebones desktop experience:
- `dwm` for window management
- `ranger` for your file browser
-- `qutebrowser` as your core web browser
+- `firefox` as your core web browser
- `aerc` for your terminal-based mail client
- `slock` for screen locking
- `scrot`/`slop` for simple screenshot utilities
@@ -38,6 +47,12 @@ The Open Suck installer gives you the absolute barebones desktop experience:
permit nopass :wheel
```
+Also add your desired user to the `wheel` group:
+
+```
+usermod -G wheel bt
+```
+
Now logout and log back in as your main user.
---
@@ -50,16 +65,31 @@ Clone the main installer project:
## Installing
-1) Install dependencies by running `./install-dependencies.sh`. The script will simply read required packages from `dependencies.txt` and run `pkg_add`.
-2) Compile and install suckless software by running the `./install.sh`
-3) Core program files (dwm, dmenu, etc) will be placed inside a newly created `open-suck-core` directory. Feel free to delete, rename or move this.
+1. Install dependencies
+2. Compile and install suckless software
## TL;DR
```sh
cd open-suck-installer # CD into this repository
doas sh ./install-dependencies.sh # Install OpenBSD packages
-doas sh ./install.sh # Install suckless tools
+```
+
+### Installing on a Laptop
+
+```
+doas sh ./install-laptop.sh
+```
+
+### Installing on a Desktop
+
+```
+doas sh ./install-desktop.sh
+```
+
+Copy over `.xinitrc`:
+
+```
cp .xinitrc ~/.xinitrc # Apply .xinitrc
```
@@ -73,7 +103,7 @@ startx
## Optimizing OpenBSD
-### Improving Battery Performance
+### Improving Battery Performance / Enabling Sleep
Properly setup apmd:
@@ -87,18 +117,21 @@ rcctl start apmd
> The following assumes you have installed/setup the proper firmware updates for your hardware.
+Create a new file `hostname.iwn0` (change the extensions to what is reported
+via `ifconfig`)
```
-ifconfig iwn0 up
-ifconfig iwn0 scan
-echo "join WIFI-NAME wpakey PASSPHRASE" >> /etc/hostname.iwn0
-echo "dhcp" >> /etc/hostname.iwn0
-echo "inet6 autoconf" >> /etc/hostname.iwn0
-echo "up powersave" >> /etc/hostname.iwn0
-dhclient iwn0
+join WIFI-NAME wpakey PASSPHRASE
+dhcp
+inet6 autoconf
+up powersave
```
-Take note of the `iwn0`, as this might differ on your machine.
+Then run the following:
+
+```
+ifconfig iwn0 up
+```
You might also need to run `doas sh /etc/netstart` after.