Initial commit to cgit and place all suckless programs within installer

1 files changed, 105 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6137273
--- /dev/null
+++ b/README.md
@@ -0,0 +1,105 @@
+# Suckless Beastie
+
+Lightweight Desktop installer for FreeBSD based on the suckless philosophy.
+Includes my own custom set of suckless tools (dwm, slstatus, dmenu, etc.)
+
+![Screenshot of dwm running on FreeBSD](/~bt/suckless-beastie/blob/master/screenshot.png)
+
+Successfully installed on:
+
+- ThinkPad X220
+
+## What You Get
+
+The Suckless Beastie installer gives you the absolute barebones desktop experience:
+
+- `dwm` for window management
+- Firefox as your core web browser
+- `aerc` for your terminal-based mail client
+- `slock` for screen locking
+- `scrot`/`slop` for simple screenshot utilities
+- `dunst` for notifications
+
+## Downloading
+
+1. Download the latest FreeBSD iso and follow the installer
+2. Login as `root`
+3. Install `git`, `vim`, `bash`, `doas`
+4. Edit/create doas permissions (`/usr/local/etc/doas.conf`):
+
+```
+permit nopass :wheel
+```
+
+(Also ensure your main user is added to the `wheel` group):
+
+```
+pw groupmod wheel -m username
+```
+
+Now logout and log back in as your main user.
+
+---
+
+Clone the main installer project:
+
+`git clone https://git.sr.ht/~bt/suckless-beastie`
+
+`cd suckless-beastie`
+
+## Overview
+
+1) Install dependencies by running `./install-dependencies.sh`. The script will simply read required packages from `dependencies.txt` and run `pkg install`.
+2) Compile and install suckless software by running the `./install.sh`
+
+## Installing
+
+Before running the installer, be sure to edit the main `install.sh` file and change the username "bt" to your own:
+
+```sh
+mkdir /home/bt/.suckless
+cd /home/bt/.suckless
+```
+
+Then you are free to install:
+
+```sh
+cd suckless-beastie # CD into this repository
+doas sh ./install-dependencies.sh # Install FreeBSD packages
+```
+
+```sh
+doas sh ./install.sh # Build and install suckless tools
+cp .xinitrc ~/.xinitrc # Apply .xinitrc
+```
+
+## Xorg Permissions
+
+Add your main user to the `video` group:
+
+```
+pw groupmod video -m username
+```
+
+### Setting Up Graphic Cards
+
+```
+pkg install drm-kmod
+```
+
+Edit `/etc/rc.conf` based on your graphic card:
+
+```
+# Intel
+sysrc kld_list+=i915kms
+# AMD
+sysrc kld_list+=amdgpu
+```
+
+## Finishing Touches
+
+Reboot the machine. Log in as your main user. Run:
+
+```
+startx
+```