diff --git a/README.md b/README.md new file mode 100644 index 0000000..b721b15 --- /dev/null +++ b/README.md @@ -0,0 +1,198 @@ +# Awesome WM Copycats + +## Themes for Awesome WM 4.x + +Author + +: Luca CPZ + +Version + +: git + +License + +: [BY-SA](https://creativecommons.org/licenses/by-sa/4.0) + +Source + +: + +# Description + +A set of themes for the [Awesome](http://github.com/awesomeWM/awesome) +window manager, version 4.x. + +See [branches](https://github.com/lcpz/awesome-copycats/branches) for +previous versions. + +# Purpose + +The main purpose of this repository is to spread ready to use +configurations, which can also serve as a cookbook for customisation. + +A secondary aim is to add new themes only when they constitute different +UI/UX designs. + +# Features + +- Modularity +- Autohide widgets +- Autostart windowless processes +- Fast MPD and volume shortcuts (first time this trick has been used + in Awesome) +- Shortcuts for copying to the clipboard, toggle wiboxes, widgets + popups, screenshots capture, moving and magnifying clients +- Quake drop-down terminal +- Calendar with current day highlighted and months switch with a + click/scroll +- Notifications for new mails, current song, volume level, hdd + critical state, low battery +- OpenWeatherMap integration +- Net carrier status notifier +- Symbolic tag names +- DWM-like textual layoutbox +- Cairo wibar +- Custom layouts +- No borders when there\'s only one visible client +- Freedesktop.org compliant menu and desktop icons +- Vi-like client focus +- Non-empty tag browsing +- On-the-fly useless gaps resize +- Dynamic tagging + +# Gallery + +**Multicolor**, inspired by +[lucamanni](https://github.com/lucamanni/awesome) + +![image](http://dotshare.it/public/images/uploads/650.png) + +**Powerarrow**, porting of +[romockee](https://github.com/romockee/powerarrow)\'s + +![image](http://dotshare.it/public/images/uploads/1453.png) + +**Powerarrow Dark** + +![image](http://dotshare.it/public/images/uploads/649.jpg) + +**Steamburn**, porting of +[ok100](http://ok100.deviantart.com/art/DWM-January-2013-348656846)\'s +dwm + +![image](http://dotshare.it/public/images/uploads/648.png) + +**Blackburn** + +![image](http://dotshare.it/public/images/uploads/553.png) + +**Dremora** + +![image](http://dotshare.it/public/images/uploads/652.png) + +**Rainbow** + +![image](http://dotshare.it/public/images/uploads/606.png) + +**Holo**, requested by +[amouly](https://bbs.archlinux.org/viewtopic.php?pid=1307158#p1307158) + +![image](http://dotshare.it/public/images/uploads/651.jpg) + +**Copland**, inspired by [foozer](http://dotshare.it/dots/499) + +![image](http://dotshare.it/public/images/uploads/655.png) + +**Vertex**, requested by +[swordfischer](https://github.com/lcpz/awesome-copycats/issues/53) + +![image](http://dotshare.it/public/images/uploads/1432.jpg) + +# Installation + +``` shell +[[ ! -d "~/.config/awesome" ]] && mkdir -p ~/.config/awesome && git clone --recurse-submodules --remote-submodules --depth 1 -j 2 https://github.com/SirHadrian/awesome-themes.git && mv -v awesome-themes/* ~/.config/awesome && rm -rf awesome-themes +``` + +# Usage + +The modular structure allows to + +- set variables +- define startup processes +- change keybindings and layouts +- set client properties + +in `rc.lua`, and + +- configure widgets +- define wiboxes and screen settings + +in `theme.lua`, so that you just need to change `chosen_theme` variable +in `rc.lua` to preserve your preferences *and* switch the theme, instead +of having file redundancy. + +Just do the following: + +``` shell +$ cd ~/.config/awesome +$ cp rc.lua.template rc.lua +``` + +Then, set the variable `chosen_theme` in `rc.lua` to your preferred +theme, do your settings, and restart Awesome (`Mod4 + ctrl + r`). + +To customize a theme, head over to `themes/$chosen_theme/theme.lua`. + +Otherwise, if you want to be synced with upstream, modify the theme path +in `rc.lua` like this: + +``` diff +-beautiful.init(string.format("%s/.config/awesome/themes/%s/theme.lua", os.getenv("HOME"), chosen_theme)) ++beautiful.init(string.format("%s/.config/awesome/themes/%s/theme-personal.lua", os.getenv("HOME"), chosen_theme)) +``` + +then, copy `theme.lua` to `theme-personal.lua` and do your +customizations there. + +This way, you can safely `git pull` anytime. + +# Themes details + +# Powerarrow-dark + +For the weather widget to work install: + +``` shell +$ wget -P ~/.config/awesome/ https://raw.githubusercontent.com/rxi/json.lua/master/json.lua +``` + +# Notes + +Complements are provided by [lain](https://github.com/lcpz/lain) and +[freedesktop](https://github.com/lcpz/awesome-freedesktop). **Be sure** +to satisfy their +[dependencies](https://github.com/lcpz/lain/wiki#dependencies). In +particular, [mail](https://github.com/lcpz/lain/wiki/mail) and +[weather](https://github.com/lcpz/lain/wiki/weather) widgets have +**mandatory** arguments. + +The fonts used in the screenshots are: +[Terminus](http://terminus-font.sourceforge.net) (Multicolor, +Powerarrow, Powerarrow Dark), +[Roboto](https://fonts.google.com/specimen/Roboto) (Holo, Vertex) and +[Tamzen](https://github.com/sunaku/tamzen-font) (other ones). + +As taglist font, Blackburn and Dremora use +[Icons](https://github.com/lcpz/dots/tree/master/.fonts), Vertex uses +[FontAwesome](https://github.com/FortAwesome/Font-Awesome): be sure to +have bitmaps enabled if running under Debian or +[Ubuntu](https://wiki.ubuntu.com/Fonts#Enabling_Bitmapped_Fonts). + +Every theme has a +[colorscheme](https://github.com/lcpz/dots/tree/master/.colors). + +Additional default software used: : + + amixer dmenu librewolf firefox alsa-utils mpc scrot unclutter xsel xlock lightmore picom-git alacritty nitrogen diff --git a/README.rst b/README.rst deleted file mode 100644 index 77737e7..0000000 --- a/README.rst +++ /dev/null @@ -1,187 +0,0 @@ -Awesome WM Copycats -=================== - -------------------------- -Themes for Awesome WM 4.x -------------------------- - -:Author: Luca CPZ -:Version: git -:License: BY-SA_ -:Source: https://github.com/lcpz/awesome-copycats - -Description -=========== - -A set of themes for the Awesome_ window manager, version 4.x. - -See branches_ for previous versions. - -Purpose -======= - -The main purpose of this repository is to spread ready to use configurations, which can also serve as a cookbook for customisation. - -A secondary aim is to add new themes only when they constitute different UI/UX designs. - -Features -======== - -- Modularity -- Autohide widgets -- Autostart windowless processes -- Fast MPD and volume shortcuts (first time this trick has been used in Awesome) -- Shortcuts for copying to the clipboard, toggle wiboxes, widgets popups, screenshots capture, moving and magnifying clients -- Quake drop-down terminal -- Calendar with current day highlighted and months switch with a click/scroll -- Notifications for new mails, current song, volume level, hdd critical state, low battery -- OpenWeatherMap integration -- Net carrier status notifier -- Symbolic tag names -- DWM-like textual layoutbox -- Cairo wibar -- Custom layouts -- No borders when there's only one visible client -- Freedesktop.org compliant menu and desktop icons -- Vi-like client focus -- Non-empty tag browsing -- On-the-fly useless gaps resize -- Dynamic tagging - -Gallery -======= - -**Multicolor**, inspired by lucamanni_ - -.. image:: http://dotshare.it/public/images/uploads/650.png - -**Powerarrow**, porting of romockee_'s - -.. image:: http://dotshare.it/public/images/uploads/1453.png - -**Powerarrow Dark** - -.. image:: http://dotshare.it/public/images/uploads/649.jpg - -**Steamburn**, porting of ok100_'s dwm - -.. image:: http://dotshare.it/public/images/uploads/648.png - -**Blackburn** - -.. image:: http://dotshare.it/public/images/uploads/553.png - -**Dremora** - -.. image:: http://dotshare.it/public/images/uploads/652.png - -**Rainbow** - -.. image:: http://dotshare.it/public/images/uploads/606.png - -**Holo**, requested by amouly_ - -.. image:: http://dotshare.it/public/images/uploads/651.jpg - -**Copland**, inspired by foozer_ - -.. image:: http://dotshare.it/public/images/uploads/655.png - -**Vertex**, requested by swordfischer_ - -.. image:: http://dotshare.it/public/images/uploads/1432.jpg - -Installation -============ - -.. code-block:: shell - - [[ ! -d "~/.config/awesome" ]] && mkdir -p ~/.config/awesome && git clone --recurse-submodules --remote-submodules --depth 1 -j 2 https://github.com/SirHadrian/awesome-themes.git && mv -v awesome-themes/* ~/.config/awesome && rm -rf awesome-themes - -Usage -===== - -The modular structure allows to - -* set variables -* define startup processes -* change keybindings and layouts -* set client properties - -in ``rc.lua``, and - -* configure widgets -* define wiboxes and screen settings - -in ``theme.lua``, so that you just need to change ``chosen_theme`` variable in ``rc.lua`` to preserve your preferences *and* switch the theme, instead of having file redundancy. - -Just do the following: - -.. code-block:: shell - - $ cd ~/.config/awesome - $ cp rc.lua.template rc.lua - -Then, set the variable ``chosen_theme`` in ``rc.lua`` to your preferred theme, do your settings, and restart Awesome (``Mod4 + ctrl + r``). - -To customize a theme, head over to ``themes/$chosen_theme/theme.lua``. - -Otherwise, if you want to be synced with upstream, modify the theme path in ``rc.lua`` like this: - -.. code-block:: diff - - -beautiful.init(string.format("%s/.config/awesome/themes/%s/theme.lua", os.getenv("HOME"), chosen_theme)) - +beautiful.init(string.format("%s/.config/awesome/themes/%s/theme-personal.lua", os.getenv("HOME"), chosen_theme)) - -then, copy ``theme.lua`` to ``theme-personal.lua`` and do your customizations there. - -This way, you can safely ``git pull`` anytime. - -Themes details -============== - -Powerarrow-dark -=============== - -For the weather widget to work install: - -.. code-block:: shell - - $ wget -P ~/.config/awesome/ https://raw.githubusercontent.com/rxi/json.lua/master/json.lua - -Notes -===== - -Complements are provided by lain_ and freedesktop_. **Be sure** to satisfy their dependencies_. In particular, mail_ and weather_ widgets have **mandatory** arguments. - -The fonts used in the screenshots are: Terminus_ (Multicolor, Powerarrow, Powerarrow Dark), Roboto_ (Holo, Vertex) and Tamzen_ (other ones). - -As taglist font, Blackburn and Dremora use Icons_, Vertex uses FontAwesome_: be sure to have bitmaps enabled if running under Debian or Ubuntu_. - -Every theme has a colorscheme_. - -Additional default software used: :: - - amixer dmenu librewolf firefox alsa-utils mpc scrot unclutter xsel xlock lightmore picom-git alacritty nitrogen - -.. _BY-SA: https://creativecommons.org/licenses/by-sa/4.0 -.. _Awesome: http://github.com/awesomeWM/awesome -.. _branches: https://github.com/lcpz/awesome-copycats/branches -.. _lucamanni: https://github.com/lucamanni/awesome -.. _romockee: https://github.com/romockee/powerarrow -.. _ok100: http://ok100.deviantart.com/art/DWM-January-2013-348656846 -.. _amouly: https://bbs.archlinux.org/viewtopic.php?pid=1307158#p1307158 -.. _swordfischer: https://github.com/lcpz/awesome-copycats/issues/53 -.. _foozer: http://dotshare.it/dots/499 -.. _lain: https://github.com/lcpz/lain -.. _freedesktop: https://github.com/lcpz/awesome-freedesktop -.. _Terminus: http://terminus-font.sourceforge.net -.. _Roboto: https://fonts.google.com/specimen/Roboto -.. _Tamzen: https://github.com/sunaku/tamzen-font -.. _Icons: https://github.com/lcpz/dots/tree/master/.fonts -.. _FontAwesome: https://github.com/FortAwesome/Font-Awesome -.. _Ubuntu: https://wiki.ubuntu.com/Fonts#Enabling_Bitmapped_Fonts -.. _colorscheme: https://github.com/lcpz/dots/tree/master/.colors -.. _dependencies: https://github.com/lcpz/lain/wiki#dependencies -.. _mail: https://github.com/lcpz/lain/wiki/mail -.. _weather: https://github.com/lcpz/lain/wiki/weather