From 35643435c57b822b0347d6f53fa189736b03b91e Mon Sep 17 00:00:00 2001
From: the_4n0nym0u53 <hello@theanonymouse.xyz>
Date: Thu, 30 Dec 2021 15:38:46 +0100
Subject: [PATCH] Revamp README(s).

---
 README.md          | 39 +++++++++++----------------------------
 nvim/README.md     |  5 +++++
 scripts/README.md  |  5 +++++
 sway/README.md     |  7 +++++++
 swaylock/README.md |  3 +++
 waybar/README.md   |  3 +++
 6 files changed, 34 insertions(+), 28 deletions(-)
 create mode 100644 nvim/README.md
 create mode 100644 scripts/README.md
 create mode 100644 sway/README.md
 create mode 100644 swaylock/README.md
 create mode 100644 waybar/README.md

diff --git a/README.md b/README.md
index 2b5bcab..29cdfb8 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ This is a collection of some of my dotfiles for my Artix Linux system.
 
 ![Screenshot](./.img/screenshot.png)
 
-You can install these dotfiles by cloning this repository and executing `install.sh`.
+You can install these dotfiles by cloning this repository and executing `install.sh`:
 
 ```bash
 $ git clone https://github.com/theanonymousexyz/dotfiles.git
@@ -13,32 +13,15 @@ $ chmod +x install.sh
 $ ./install.sh
 ```
 
-This configuration depends on the following packages\*:
+Note that I use `doas` instead of `sudo`. If you prefer `sudo`, then change all instances of `doas` to `sudo`, or simply create a symlink `doas` pointing to `sudo`:
 
-- `alacritty`
-- `artix-backgrounds`
-- `doas`\*\*
-- `git`
-- `grimshot`
-- `ivpn` (daemon + CLI)
-- `mako`
-- `neovim`
-- `pavucontrol`
-- `pipewire`
-- `playerctl`
-- `python`
-- `stow`
-- `sway`
-- `swaylock-effects`
-- `sway-launcher-desktop`
-- `waybar`
-- `wireplumber`
-- `wl-clipboard`
-- `zsh`
-
-\* Feel free to change anything to your liking.
-
-\*\* If you prefer `sudo`, then change all instances of `doas` to `sudo`.
-
-Also, you need to make `doas`/`sudo` rules that allow you to execute `ivpn-service`, `poweroff`, `reboot` and `pkill ivpn-service` without a password, otherwise the keybindings and scripts for those won't work.
+```bash
+sudo ln -s $(which sudo) /usr/bin/doas
+```
 
+**Notes:**
+- You need to make `doas`/`sudo` rules that allow you to execute, `poweroff` and `reboot` (and additionally `ivpn-service` and `pkill "^ivpn-service$"` if you use IVPN) without a password, otherwise the keybindings and scripts for those won't work.
+- The install script requires GNU Stow to work.
+- Make sure to thoroughly examine these dotfiles and change them to your needs before using them.
+- See the READMEs for some of the packages here for special notes.
+- Optionally fork this repository to make maintenance easier.
diff --git a/nvim/README.md b/nvim/README.md
new file mode 100644
index 0000000..e733a1e
--- /dev/null
+++ b/nvim/README.md
@@ -0,0 +1,5 @@
+# Neovim config
+
+This Neovim config requires [vim-plug](https://github.com/junegunn/vim-plug) for plugins.
+
+To install the plugins from the config file, first install vim-plug, and then run `PlugInstall` inside Neovim.
diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000..043bb14
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,5 @@
+# Scripts
+
+For these custom scripts to work, you need to add `$HOME/.local/bin` to your `PATH`.
+
+If you use my Zsh config, this is already taken care of.
diff --git a/sway/README.md b/sway/README.md
new file mode 100644
index 0000000..803ff06
--- /dev/null
+++ b/sway/README.md
@@ -0,0 +1,7 @@
+# Sway config
+
+My Sway config currently uses and/or depends on the following packages:
+
+- `artix-backgrounds` for the wallpaper
+- `grimshot` for screenshotting
+- `sway-launcher-desktop` for launching applications
diff --git a/swaylock/README.md b/swaylock/README.md
new file mode 100644
index 0000000..03476f4
--- /dev/null
+++ b/swaylock/README.md
@@ -0,0 +1,3 @@
+# Swaylock config
+
+This config is in fact for `swaylock-effects`, which you can get from the AUR.
diff --git a/waybar/README.md b/waybar/README.md
new file mode 100644
index 0000000..96404f5
--- /dev/null
+++ b/waybar/README.md
@@ -0,0 +1,3 @@
+# Waybar config
+
+This is a beautifully styled config for Waybar, featuring a solarized dark coloscheme and a custom module for showing IVPN connection status (thus requires IVPN client).