aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 0512e52c9f3c674c2fef2c3895ba103f534ee5f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
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.

- dl
- src
- doc
- proj
- media


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


Recommended
-----------
This programs are not required but I recommend you to install.

dash: run scripts faster
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 found my setup interesting, feel free to donate.
https://ryo.nopwd.lol/pub/donate.html