still fixing the readme
[danixland-rofi.git] / README.md
CommitLineData
6e5a5ccb 1# danixland-rofi
2
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.
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
9Now 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.
10
11### Prerequisites
12
13Of course you need [rofi](https://github.com/davatorium/rofi) installed in your system.
14
15In 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.
16
17### Does it looks like a bitch??!!
18
19Here's what the theme looks like:
20
cafbc7f0 21![The power menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/powermenu.png "The power menu")
ddd0e3a7 22The power menu with shutdown, reboot, lock, suspend, close session options
cafbc7f0 23
24![The applications list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/appsmenu.png "The applications list")
ddd0e3a7 25An application list with icons
cafbc7f0 26
27![The ssh quick connection list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/sshmenu.png "The ssh quick connection list")
ddd0e3a7 28rofi reads the config for ssh inside your home and gives you a menu with your connections.
cafbc7f0 29
30![The window list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/windowmenu.png "The window list")
ddd0e3a7 31A list of currently open windows, both for the local desktop or global.
cafbc7f0 32
33![The scrot menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/scrotmenu.png "The scrot menu")
ddd0e3a7 34A simple scrot menu.
cafbc7f0 35
36![The utils menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/utilsmenu.png "The utils menu")
ddd0e3a7 37Some 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 38
39## Built With
40
ddd0e3a7 41* Patience, really.. it's all that easy.
42* This theme uses the [Hurmit Nerd Font](https://www.nerdfonts.com/) for his icons.
6e5a5ccb 43
44## Authors
45
ddd0e3a7 46* **danix** - *Author* - [danix.xyz](https://danix.xyz)
6e5a5ccb 47
48## License
49
ddd0e3a7 50This project is free to use. Take it and do whatever you want with it!!
6e5a5ccb 51
52## Acknowledgments
53
ddd0e3a7 54* [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.