added send to device shell script.
[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 All 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 work on [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-gaps](https://github.com/Airblader/i3) - My window manager of choice.
15 * [feh](https://feh.finalrewind.org/) - wallpaper setter. Fast and lightweight.
16 * [conky](https://github.com/brndnmtthws/conky) - system monitor, I use it for my desk clock, but it can do so so much more.
17 * [rofi](https://github.com/davatorium/rofi) - Extremely customizable dmenu replacement, I use the git version.
18 * [tint2](https://gitlab.com/o9000/tint2) - Great lightweight bar that can run custom scripts.
19 * [compton](https://github.com/chjj/compton) - Lightweight compositor.
20
21 ### Installing
22
23 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.
24
25 **i3**, **conky**, **rofi** and **tint2** directories must go inside your `~/.config` directory, this is standard and you shouldn't have any problems with it.
26
27 **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:
28 ```
29 $> ls /home/danix
30 .Xresources
31 .bash_profile
32 .bashrc
33 .xinitrc
34 [...]
35 ```
36 Here's how it looks for me on a fresh install:
37 ```
38 $> tree /home/danix
39 ├── .Xresources
40 ├── .bash_profile
41 ├── .bashrc
42 ├── bin/
43 │   ├── blackpearl-appsmenu.sh
44 │   ├── blackpearl-powermenu.sh
45 │   ├── blackpearl-runner.sh
46 │   ├── blackpearl-scrotmenu.sh
47 │   ├── blackpearl-sshmenu.sh
48 │   ├── blackpearl-utilsmenu.sh
49 │   ├── blackpearl-window.sh
50 │   └── executors/
51 │   ├── caps
52 │   ├── inet
53 │   ├── mail-check
54 │   ├── psuinfo.py
55 │   └── wifi-name
56 ├── .config/
57 │   ├── compton.conf
58 │   ├── i3/
59 │   |   └── config
60 │   ├── conky/
61 │   |   └── qlocktwo.conkyrc
62 │   ├── rofi/
63 │   |   └── blackpearl/
64 │   |   ├── appmenu.rasi
65 │   |   ├── i3exit.rasi
66 │   |   ├── powermenu.rasi
67 │   |   ├── runner.rasi
68 │   |   ├── scrotmenu.rasi
69 │   |   ├── shared/
70 │   |   │   ├── reset.rasi
71 │   |   │   └── settings.rasi
72 │   |   └── utilsmenu.rasi
73 │   └── tint2/
74 │      ├── i3status.tint2rc
75 │      └── minima.tint2rc
76 └── .xinitrc
77 ```
78
79 ## Authors
80
81 * **danix** - [danix.xyz](https://danix.xyz)
82
83 ## License and Acknowledgments
84
85 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.