modified: README.md
[danixland-rofi.git] / README.md
1 # danixland-rofi
2
3 A 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.
4
5 ## Getting Started
6
7 Copy 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
9 ```
10 cp ~/Downloads/danixland-rofi/scripts/*.sh ~/bin
11 chmod 755 ~/bin/danixland-*.sh
12 ```
13
14 Now 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 ```
17 mkdir ~/.config/rofi/danixland
18 cd ~/.config/rofi/danixland
19 cp -R ~/Downloads/danixland-rofi/theme/* .
20 ```
21
22 ```
23 vim ~/bin/danixland-appsmenu.sh
24 ```
25 If you want you can rename the scripts as well. It's up to you.
26
27 This 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.
28
29 ### Prerequisites
30
31 Of course you need [rofi](https://github.com/davatorium/rofi) installed in your system.
32
33 In 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.
34
35 Being familiar with bash scripting might be useful ;)
36
37 ### Does it looks like a bitch??!!
38
39 Here's what the theme looks like:
40 >Some of these screenshots are old and you'll notice the icons are a bit offset and not very well centered. I fixed that inside the theme files.
41
42 ![The power menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/powermenu.png "The power menu")
43
44 The power menu with shutdown, reboot, lock, suspend, close session options
45
46 ![The applications list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/appsmenu.png "The applications list")
47
48 An application list with icons
49
50 ![The ssh quick connection list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/sshmenu.png "The ssh quick connection list")
51
52 rofi reads the config for ssh inside your home and gives you a menu with your connections.
53
54 ![The window list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/windowmenu.png "The window list")
55
56 A list of currently open windows, both for the local desktop or global.
57
58 ![The scrot menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/scrotmenu.png "The scrot menu")
59
60 A simple scrot menu.
61
62 ![The utils menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/utilsmenu.png "The utils menu")
63
64 Some 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.
65
66 ## Built With
67
68 * Patience, really.. it's all that easy.
69 * This theme uses the [Hurmit Nerd Font](https://www.nerdfonts.com/) for his icons.
70
71 ## Authors
72
73 * **danix** - *Author* - [danix.xyz](https://danix.xyz)
74
75 ## License
76
77 This project is free to use. Take it and do whatever you want with it!!
78
79 ## Acknowledgments
80
81 * [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.