From c2b225417f506f69b7a3fc6200693afea724e48f Mon Sep 17 00:00:00 2001 From: Suleyman Farajli Date: Sat, 28 Jun 2025 01:04:26 +0400 Subject: docs: README.md updated --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 +``` + +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 From 989bd3381746fc428c6d0e93be8d36bc54ab2799 Mon Sep 17 00:00:00 2001 From: Suleyman Farajli Date: Sat, 28 Jun 2025 01:07:13 +0400 Subject: docs(readme): typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f395bce..0054767 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ If you like the setup then you can install it for your main user. useradd -m -s /bin/zsh ``` -2. run +3. run ``` bash make ``` -3. Log out, log back in, and run `startx` on the TTY. +4. Log out, log back in, and run `startx` on the TTY. # Dependencies ## Build time dependencies -- cgit v1.2.3 From 5621fb85dbccc48e98a2768d62ba2db593462f7e Mon Sep 17 00:00:00 2001 From: Suleyman Farajli Date: Sat, 28 Jun 2025 01:08:23 +0400 Subject: docs(readme): remove firefox from dependencies --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0054767..02a36db 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ make - nsxiv or sxiv - nvim or vim - picom -- qutebrowser or firefox +- qutebrowser - scrot - setxkbmap - xorg-xinit -- cgit v1.2.3 From d01aa72037643860458263fb8556943768bd268b Mon Sep 17 00:00:00 2001 From: Suleyman Farajli Date: Sat, 28 Jun 2025 01:37:15 +0400 Subject: doc(readme): add minimal version support for lf and nvim --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 02a36db..349db0b 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,11 @@ make - dunst - fzf - git -- lf +- lf >= r31 - mpv - libnotify (notify-send command) - nsxiv or sxiv -- nvim or vim +- nvim >= 0.10.3 or vim - picom - qutebrowser - scrot -- cgit v1.2.3