modified: README.md
[danixland-rofi.git] / README.md
index 3f8be6f..29f1bde 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,51 +1,81 @@
 # danixland-rofi
 
-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.
+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.
 
 ## Getting Started
 
 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.
 
-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.
+```
+cp ~/Downloads/danixland-rofi/scripts/*.sh ~/bin
+chmod 755 ~/bin/darknix-*.sh
+```
+
+Now copy the content of the **theme** directory inside `~/.config/rofi/darknix` (change theme name to whatever you want to call it) and change "themename" to whatever you called it, inside every single bash script.
+
+```
+mkdir ~/.config/rofi/darknix
+cd ~/.config/rofi/darknix
+cp -R ~/Downloads/danixland-rofi/theme/* .
+```
+
+```
+vim ~/bin/darknix-appsmenu.sh
+```
+If you want you can rename the scripts as well. It's up to you.
+
+This theme uses the [Inconsolata 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.
 
 ### Prerequisites
 
 Of course you need [rofi](https://github.com/davatorium/rofi) installed in your system.
 
 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.
+Being familiar with bash scripting might be useful ;)
 
 ### Does it looks like a bitch??!!
 
 Here's what the theme looks like:
+>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.
 
-![power menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/powermenu.png "The power down menu")
+![The power menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/powermenu.png "The power menu")
 
-## Built With
+The power menu with shutdown, reboot, lock, suspend, close session options
 
-* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
-* [Maven](https://maven.apache.org/) - Dependency Management
-* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
+![The applications list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/appsmenu.png "The applications list")
 
-## Contributing
+An application list with icons
 
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+![The ssh quick connection list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/sshmenu.png "The ssh quick connection list")
 
-## Versioning
+rofi reads the config for ssh inside your home and gives you a menu with your connections.
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+![The window list](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/windowmenu.png "The window list")
 
-## Authors
+A list of currently open windows, both for the local desktop or global.
+
+![The scrot menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/scrotmenu.png "The scrot menu")
 
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
+A simple scrot menu.
+
+![The utils menu](http://git.danix.xyz/danixland-rofi.git/raw/master/screenshots/utilsmenu.png "The utils menu")
+
+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.
+
+## Built With
+
+* Patience, really.. it's all that easy.
+* This theme uses the [Inconsolata Nerd Font](https://www.nerdfonts.com/) for his icons.
+
+## Authors
 
-See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+* **danix** - *Author* - [danix.xyz](https://danix.xyz)
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+This project is free to use. Take it and do whatever you want with it!!
 
 ## Acknowledgments
 
-* Hat tip to anyone whose code was used
-* Inspiration
-* etc
+* [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.