From c2b225417f506f69b7a3fc6200693afea724e48f Mon Sep 17 00:00:00 2001
From: Suleyman Farajli <suleyman@farajli.net>
Date: Sat, 28 Jun 2025 01:04:26 +0400
Subject: docs: README.md updated

---
 README    | 18 ----------------
 README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+), 18 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index c56825d..0000000
--- a/README
+++ /dev/null
@@ -1,18 +0,0 @@
-slcf - Suleyman's linux configuration files
-===========================================
-My personal dotfiles.
-
-Installing slcf
----------------
-slcf only installs dotfiles to the home directory of the user running the Makefile
-and doesn't affect other users. Therefore, it's recommended to create a new user
-and run make as that user. If you like the setup then you can install it for your main user.
-
-Check the dependencies
-> make depcheck
-
-Install config and scripts
-> make config scripts
-
-Install everything
-> make full
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f395bce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+# slcf - Suleyman's linux configuration files
+My linux xorg configuration.
+
+slcf only installs configuration to the home directory of the user running the Makefile 
+and doesn't affect other users or make system-wide changes but it does overwrites the current configuration,
+so, it's recommended to create a new user and run make as that user.
+If you like the setup then you can install it for your main user.
+
+# Instlallation 
+1. Make sure to use Zsh or Bash as your interactive shell, have an internet connection, and install at least the build-time dependencies.
+
+2. Create a new user (set shell either to Zsh or Bash):
+```
+useradd -m -s /bin/zsh <user> 
+```
+
+2. run 
+``` bash
+make
+```
+3. Log out, log back in, and run `startx` on the TTY.
+
+# Dependencies 
+## Build time dependencies
+- curl
+- fontconfig (fc-cache command)
+- gcc 
+- ld
+- make
+- ncurses (tic command)
+- pkg-config
+- tar
+
+## Build time libraries
+- libx11
+- libxft
+- libxinerama
+
+## Program dependencies (optional but recommended)
+- Xorg                               
+- dunst                              
+- fzf                                
+- git                                
+- lf                                 
+- mpv                                
+- libnotify (notify-send command)
+- nsxiv or sxiv                         
+- nvim or vim                           
+- picom                              
+- qutebrowser or firefox                      
+- scrot                              
+- setxkbmap                          
+- xorg-xinit
+- xclip                              
+- zathura                            
+- zsh or bash
+
+## Script dependencies (optional but recommended)
+- brightnessctl                 
+- pulseaudio                    
+- xgamma                        
+- xinput                        
+- xset                          
+- xwallpaper
+
+# Notes
+- Refer to [my dwm build man page](https://git.farajli.net/dwm.git/tree/dwm.1) for keybinds.
+
+# Troubleshooting
+- brightnessctl can require privileged user to function, to solve it refer to [brightnessctl page](https://github.com/Hummer12007/brightnessctl#Permissions).
+- pulseaudio sometimes doesn't start automatically to start it manually run `pulseaudio --start`.
-- 
cgit v1.2.3