Added few more infos on the Readme
[danixland-rofi.git] / README.md
CommitLineData
6e5a5ccb 1# danixland-rofi
2
ffb4cf73 3A set of scripts for my personal Rofi theme. Follow the instructions and it should be pretty much drop and play, but it might need a little editing if your screen size is different or if you don't like the color scheme. The files are imported one on top of the other in a way similiar to Sass, so the screen resolution file and the color scheme file are in two separated files that can be tweaked without having to modify the whole theme.
6e5a5ccb 4
5## Getting Started
6
7Copy the content of the **scripts** directory wherever you put your personal scripts, I use `~/bin` for my user scripts or `/usr/local/bin` for system wide scripts that can be used by all users on my system. In this case I have everything inside my home.
8
ffb4cf73 9```
10cp ~/Downloads/danixland-rofi/scripts/*.sh ~/bin
11chmod 755 ~/bin/danixland-*.sh
12```
13
14Now copy the content of the **theme** directory inside `~/.config/rofi/themename` (change theme name to whatever you want to call it) and change "themename" to whatever you called it, inside every single bash script.
15
16```
17mkdir ~/.config/rofi/danixland
18cd ~/.config/rofi/danixland
19cp -R ~/Downloads/danixland-rofi/theme/* .
20```
21
22```
23vim ~/bin/danixland-appsmenu.sh
24```
25If you want you can rename the scripts as well. It's up to you.
26
27This theme uses the [Hurmit Nerd Font](https://www.nerdfonts.com/) for the icons you see on the buttons, if you want to use a different font you might need to adjust all the paddings. To check if an icon is available on the Hurmit Nerd Font you can go to [Nerd Font Cheat Sheet](https://www.nerdfonts.com/cheat-sheet) website and search for it.
6e5a5ccb 28
29### Prerequisites
30
31Of course you need [rofi](https://github.com/davatorium/rofi) installed in your system.
32
33In case you want to modify the theme you might need to have a look at [the wiki on how rasi themes work](https://github.com/davatorium/rofi/blob/1ab3e571eca1768d437246ca6ec09f44432b0e20/doc/rofi-theme.5.markdown), it's a dialect of CSS so it shouldn't be difficult.
ffb4cf73 34
35Being familiar with bash scripting might be useful ;)
6e5a5ccb 36
37### Does it looks like a bitch??!!
38
39Here's what the theme looks like:
40
cafbc7f0 41![The power menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/powermenu.png "The power menu")
9384f539 42
ddd0e3a7 43The power menu with shutdown, reboot, lock, suspend, close session options
cafbc7f0 44
45![The applications list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/appsmenu.png "The applications list")
9384f539 46
ddd0e3a7 47An application list with icons
cafbc7f0 48
49![The ssh quick connection list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/sshmenu.png "The ssh quick connection list")
9384f539 50
ddd0e3a7 51rofi reads the config for ssh inside your home and gives you a menu with your connections.
cafbc7f0 52
53![The window list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/windowmenu.png "The window list")
9384f539 54
ddd0e3a7 55A list of currently open windows, both for the local desktop or global.
cafbc7f0 56
57![The scrot menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/scrotmenu.png "The scrot menu")
9384f539 58
ddd0e3a7 59A simple scrot menu.
cafbc7f0 60
61![The utils menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/utilsmenu.png "The utils menu")
9384f539 62
ddd0e3a7 63Some utility scripts that I run usually. Here you can see one to change the wallpaper and another one to start the local web server on my laptop.
6e5a5ccb 64
65## Built With
66
ddd0e3a7 67* Patience, really.. it's all that easy.
68* This theme uses the [Hurmit Nerd Font](https://www.nerdfonts.com/) for his icons.
6e5a5ccb 69
70## Authors
71
ddd0e3a7 72* **danix** - *Author* - [danix.xyz](https://danix.xyz)
6e5a5ccb 73
74## License
75
ddd0e3a7 76This project is free to use. Take it and do whatever you want with it!!
6e5a5ccb 77
78## Acknowledgments
79
ffb4cf73 80* [vahnrr](https://gitlab.com/vahnrr/rofi-menus/tree/master) is the original author of the rofi theme from which I took inspiration. I just adapted his work to my system and personal taste, so all the credits go back to him.