From cc6d6fcfc6e8403e87dae9f092e61f0edf8e3cc6 Mon Sep 17 00:00:00 2001
From: ryo <ryo@nopwd.lol>
Date: Wed, 30 Oct 2024 20:10:03 +0000
Subject: Initial commit

---
 README | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..78e8f94
--- /dev/null
+++ b/README
@@ -0,0 +1,80 @@
+Requirements
+------------
+Setup contains some programs so you should install them.
+All of them are included in many linux distros like Arch and Void.
+
+zsh: main shell
+dash: run scripts faster
+i3: window manager
+i3blocks: i3 status bar
+alacritty: terminal emulator
+neovim: best editor
+opendoas: sudo replacement
+brightnessctl: adjust brightness
+firefox: web browser
+pulseaudio: sound server
+pamixer: pulseaudio mixer
+dunst: notification daemon
+setxkbmap: set keyboard map
+unclutter: hide mouse cursor
+
+
+Installation
+------------
+You should copy and rename files to specific places.
+Make a backup from same files in my config and yours then continue.
+
+$ cp -ir config/* ~/.config
+$ cp -i zprofile ~/.zprofile
+$ cp -i bin/* ~/.local/bin
+
+Read '.zprofile' and create directories that you see in variables
+so programs can use them.
+
+
+Folders Structure
+-----------------
+It's not necessary but just to know how my home looks like.
+
+- src
+- doc
+- media
+- pocket
+- proj
+
+
+Zsh config
+----------
+For autosuggestion and syntax highlighting to this steps.
+
+I assume the place for them is 'src' so:
+$ cd ~/src
+
+You need to clone:
+url1 - https://github.com/zsh-users/zsh-autosuggestions
+url2 - https://github.com/zdharma-continuum/fast-syntax-highlighting
+I change the names because they are long 
+$ alias hgit='git clone --depth=1 --no-tags --single-branch'
+$ hgit <url1> zsh-as
+$ hgit <url2> zsh-fsh
+
+
+Good to have
+------------
+This programs are not required but I recommend you to install.
+
+tmux: terminal multiplexer
+mpv: media player
+curl: download/upload data
+scrot: screenshot utility
+xclip: clipboard for x11
+ffmpeg: record and convert video
+pulsemixer: tui pulseaudio mixer
+nsxiv: image viewer
+fzf: fuzzy finder
+
+
+Donate
+------
+If you have found my setup interesting feel free to donate.
+https://ryo.nopwd.lol/pub/donate.html
-- 
cgit v1.2.3