mass update.
[my-dotfiles.git] / README.md
1 # My Dotfiles
2
3 This is the collection of dotfiles that I use on my laptop for ricing pourposes
4
5 ## Getting Started
6
7 Most of these files will go in your home directory. See [Installing](#Installing) for a brief description of where to put each file in this repository.
8
9 ### Prerequisites
10
11 You should know how linux works at least a little bit, but you can use this setup as your starting point, so Bash is a must.
12 I use [Slackware](http://www.slackware.com/) since 2006, so you'll have to adapt everything if you're using another distro. As for the software used here you have it:
13
14 * [i3](https://i3wm.org/) - My window manager of choice.
15 * [feh](https://feh.finalrewind.org/) - wallpaper setter. Fast and lightweight.
16 * [rofi](https://github.com/davatorium/rofi) - Extremely customizable dmenu replacement, I use the git version.
17 * [picom](https://github.com/yshui/picom) - Lightweight compositor.
18 * [polybar](https://github.com/polybar/polybar/) - Lightweight but highly configurable bar.
19
20 ### Installing
21
22 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.
23
24 **i3**, **conky**, **rofi** and **polybar** directories must go inside your `~/.config` directory, this is standard and you shouldn't have any problems with it.
25
26 **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:
27 ```
28 $> ls /home/danix
29 .Xresources
30 .bash_profile
31 .bashrc
32 .xinitrc
33 [...]
34 ```
35
36 Here's how it looks for me on a fresh install:
37
38 ```
39 $> tree /home/danix
40 ├── .Xresources
41 ├── .bash_profile
42 ├── .bashrc
43 ├── bin/
44 │   ├── blackpearl-appsmenu.sh
45 │   ├── blackpearl-powermenu.sh
46 │   ├── blackpearl-runner.sh
47 │   ├── blackpearl-scrotmenu.sh
48 │   ├── blackpearl-sshmenu.sh
49 │   ├── blackpearl-utilsmenu.sh
50 │   ├── blackpearl-window.sh
51 │   └── executors/
52 │   ├── caps
53 │   ├── inet
54 │   ├── mail-check
55 │   ├── psuinfo.py
56 │   └── wifi-name
57 ├── .config/
58 │   ├── compton.conf
59 │   ├── i3/
60 │   |   └── config
61 │   ├── conky/
62 │   |   └── qlocktwo.conkyrc
63 │   ├── rofi/
64 │   |   └── blackpearl/
65 │   |   ├── appmenu.rasi
66 │   |   ├── i3exit.rasi
67 │   |   ├── powermenu.rasi
68 │   |   ├── runner.rasi
69 │   |   ├── scrotmenu.rasi
70 │   |   ├── shared/
71 │   |   │   ├── reset.rasi
72 │   |   │   └── settings.rasi
73 │   |   └── utilsmenu.rasi
74 │   └── tint2/
75 │      ├── i3status.tint2rc
76 │      └── minima.tint2rc
77 └── .xinitrc
78 ```
79
80 ## Authors
81
82 * **danix** - [danix.xyz](https://danix.xyz)
83
84 ## License and Acknowledgments
85
86 This project is free to use as it is, if you need help you can contact me on my site and I'll try and help you, but you maybe luckier asking your questions on the [unixporn thread on reddit](https://www.reddit.com/r/unixporn/), which is where I found the inspiration and most of the links to make all this work.