From 60670458df0f6d078d80f59d779281c473c5d104 Mon Sep 17 00:00:00 2001
From: danix <danix@danix.xyz>
Date: Wed, 6 Nov 2024 14:03:09 +0100
Subject: [PATCH] updated README

---
 README.md                                     | 49 ++++++++-----------
 .../is_installed.bash-completion              |  0
 .../bash_completion.d/sbopkg.bash             |  0
 {etc => system-etc}/issue.blackpearl          |  0
 {etc => system-etc}/issue.buildbox            |  0
 {etc => system-etc}/profile.d/blackpearl.sh   |  0
 6 files changed, 20 insertions(+), 29 deletions(-)
 rename {etc => system-etc}/bash_completion.d/is_installed.bash-completion (100%)
 rename {etc => system-etc}/bash_completion.d/sbopkg.bash (100%)
 rename {etc => system-etc}/issue.blackpearl (100%)
 rename {etc => system-etc}/issue.buildbox (100%)
 rename {etc => system-etc}/profile.d/blackpearl.sh (100%)

diff --git a/README.md b/README.md
index b57b53f..2344f7e 100644
--- a/README.md
+++ b/README.md
@@ -16,14 +16,20 @@ I use [Slackware](http://www.slackware.com/) since 2006, so you'll have to adapt
 * [rofi](https://github.com/davatorium/rofi) - Extremely customizable dmenu replacement, I use the git version.
 * [picom](https://github.com/yshui/picom) - Lightweight compositor.
 * [polybar](https://github.com/polybar/polybar/) - Lightweight but highly configurable bar.
+* [pywal](https://github.com/dylanaraps/pywal) - generate and change color schemes based on your wallpaper
 
 ### Installing
 
-The **bin** directory is where we'll store all executables, so you may want to add it to your path, otherwhise you could use something like `/usr/local/bin`, but make sure to fix every reference to your executables in the other files.
+You can rename the **home-bin** directory to `/home/youruser/bin` and that's where we'll store all executables, so you may want to add it to your path, otherwhise you could use something like `/usr/local/bin`, but make sure to fix every reference to your executables in the other files.
 
-**i3**, **conky**, **rofi** and **polybar** directories must go inside your `~/.config` directory, this is standard and you shouldn't have any problems with it.
+The **home-config** directory can be renamed to `~/.config`, this is standard and you shouldn't have any problems with it. If you already have one, simply copy the content to your folder.
+
+The **tmux** folder can be moved as-is in your home and made hidden by prepending a dot in front of the name. If you already have a folder, simply move the config file in it.
+
+Inside the **system-etc** directory you'll find files that go in `/etc` and are system-wide files. Feel free to modify whatever you want.
 
 **Xresources**, **bash_profile**, **bashrc** and **xinitrc** are all hidden files and you should place them in your home prepending a dot to their names, so everything should look like this:
+
 ```
 $> ls /home/danix
 .Xresources
@@ -43,37 +49,22 @@ $> tree /home/danix
 ├── bin/
 │   ├── blackpearl-appsmenu.sh
 │   ├── blackpearl-powermenu.sh
-│   ├── blackpearl-runner.sh
-│   ├── blackpearl-scrotmenu.sh
-│   ├── blackpearl-sshmenu.sh
-│   ├── blackpearl-utilsmenu.sh
-│   ├── blackpearl-window.sh
-│   └── executors/
-│       ├── caps
-│       ├── inet
-│       ├── mail-check
-│       ├── psuinfo.py
-│       └── wifi-name
+│   └── [...]
 ├── .config/
-│   ├── compton.conf
 │   ├── i3/
 │   |   └── config
-│   ├── conky/
-│   |   └── qlocktwo.conkyrc
 │   ├── rofi/
-│   |   └── blackpearl/
-│   |       ├── appmenu.rasi
-│   |       ├── i3exit.rasi
-│   |       ├── powermenu.rasi
-│   |       ├── runner.rasi
-│   |       ├── scrotmenu.rasi
-│   |       ├── shared/
-│   |       │   ├── reset.rasi
-│   |       │   └── settings.rasi
-│   |       └── utilsmenu.rasi
-│   └── tint2/
-│       ├── i3status.tint2rc
-│       └── minima.tint2rc
+│   |   └── [...]
+│   ├── picom/
+│   |   └── [...]
+│   ├── polybar/
+│   |   └── [...]
+│   └── wal/
+│       └── [...]
+├── .tmux/
+│   ├── tmux.conf.danix
+│   └── [...]
+├── [...]
 └── .xinitrc
 ```
 
diff --git a/etc/bash_completion.d/is_installed.bash-completion b/system-etc/bash_completion.d/is_installed.bash-completion
similarity index 100%
rename from etc/bash_completion.d/is_installed.bash-completion
rename to system-etc/bash_completion.d/is_installed.bash-completion
diff --git a/etc/bash_completion.d/sbopkg.bash b/system-etc/bash_completion.d/sbopkg.bash
similarity index 100%
rename from etc/bash_completion.d/sbopkg.bash
rename to system-etc/bash_completion.d/sbopkg.bash
diff --git a/etc/issue.blackpearl b/system-etc/issue.blackpearl
similarity index 100%
rename from etc/issue.blackpearl
rename to system-etc/issue.blackpearl
diff --git a/etc/issue.buildbox b/system-etc/issue.buildbox
similarity index 100%
rename from etc/issue.buildbox
rename to system-etc/issue.buildbox
diff --git a/etc/profile.d/blackpearl.sh b/system-etc/profile.d/blackpearl.sh
similarity index 100%
rename from etc/profile.d/blackpearl.sh
rename to system-etc/profile.d/blackpearl.sh
-- 
2.20.1