Update README and files to reflect sourcehut platform

1 files changed, 104 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b25d0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,104 @@
+# Open Suck
+
+**Latest changes based off OpenBSD 7.5**
+
+Lightweight Desktop installer for OpenBSD based on the suckless philosophy.
+Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.)
+
+![Screenshot of dwm running on
+OpenBSD](./open-suck-75.png)
+
+Successfully installed on:
+
+- ThinkPad X201
+- ThinkPad X220
+- ThinkPad X260
+- Lenovo M73 Tiny
+
+## What You Get
+
+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
+- `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
+
+1. Download the latest OpenBSD iso and follow the installer
+2. Install `git`, `vim`, `bash`
+3. Edit/create doas permissions (`/etc/doas.conf`):
+
+```
+permit nopass :wheel
+```
+
+Now logout and log back in as your main user.
+
+---
+
+Clone the main installer project:
+
+`git clone https://git.sr.ht/~bt/open-suck-installer`
+
+`cd open-suck-installer`
+
+## 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.
+
+## 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
+cp .xinitrc ~/.xinitrc # Apply .xinitrc
+```
+
+Reboot the machine. Log in as your main user. Run:
+
+```
+startx
+```
+
+---
+
+## Optimizing OpenBSD
+
+### Improving Battery Performance
+
+Properly setup apmd:
+
+```
+rcctl enable apmd
+rcctl set apmd flags -A
+rcctl start apmd
+```
+
+### Setup WiFi
+
+> The following assumes you have installed/setup the proper firmware updates for your hardware.
+
+
+```
+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
+```
+
+Take note of the `iwn0`, as this might differ on your machine.
+
+You might also need to run `doas sh /etc/netstart` after.
+