.config/awesome/README.rst

   1 Awesome WM Copycats
   2 ===================
   3
   4 -------------------------
   5 Themes for Awesome WM 4.x
   6 -------------------------
   7
   8 :Author: Luca CPZ
   9 :Version: git
  10 :License: BY-NC-SA_
  11 :Source: https://github.com/lcpz/awesome-copycats
  12
  13 Description
  14 ===========
  15
  16 A set of themes for the Awesome_ window manager, version 4.x.
  17
  18 See branches_ for previous versions.
  19
  20 Purpose
  21 =======
  22
  23 The main purpose of this repository is to spread ready to use configurations, which can also serve as a cookbook for customisation.
  24
  25 A secondary aim is to add new themes only when they constitute different UI/UX designs.
  26
  27 Features
  28 ========
  29
  30 - Modularity
  31 - Autohide widgets
  32 - Autostart windowless processes
  33 - Fast MPD and volume shortcuts (first time this trick has been used in Awesome)
  34 - Shortcuts for copying to the clipboard, toggle wiboxes, widgets popups, screenshots capture, moving and magnifying clients
  35 - Quake drop-down terminal
  36 - Calendar with current day highlighted and months switch with a click/scroll
  37 - Notifications for new mails, current song, volume level, hdd critical state, low battery
  38 - OpenWeatherMap integration
  39 - Net carrier status notifier
  40 - Symbolic tag names
  41 - DWM-like textual layoutbox
  42 - Cairo wibar
  43 - Custom layouts
  44 - No borders when there's only one visible client
  45 - Freedesktop.org compliant menu and desktop icons
  46 - Vi-like client focus
  47 - Non-empty tag browsing
  48 - On-the-fly useless gaps resize
  49 - Dynamic tagging
  50
  51 Gallery
  52 =======
  53
  54 **Multicolor**, inspired by lucamanni_
  55
  56 .. image:: http://dotshare.it/public/images/uploads/650.png
  57
  58 **Powerarrow**, porting of romockee_'s
  59
  60 .. image:: http://dotshare.it/public/images/uploads/1453.png
  61
  62 **Powerarrow Dark**
  63
  64 .. image:: http://dotshare.it/public/images/uploads/649.jpg
  65
  66 **Steamburn**, porting of ok100_'s dwm
  67
  68 .. image:: http://dotshare.it/public/images/uploads/648.png
  69
  70 **Blackburn**
  71
  72 .. image:: http://dotshare.it/public/images/uploads/553.png
  73
  74 **Dremora**
  75
  76 .. image:: http://dotshare.it/public/images/uploads/652.png
  77
  78 **Rainbow**
  79
  80 .. image:: http://dotshare.it/public/images/uploads/606.png
  81
  82 **Holo**, requested by amouly_
  83
  84 .. image:: http://dotshare.it/public/images/uploads/651.jpg
  85
  86 **Copland**, inspired by foozer_
  87
  88 .. image:: http://dotshare.it/public/images/uploads/655.png
  89
  90 **Vertex**, requested by swordfischer_
  91
  92 .. image:: http://dotshare.it/public/images/uploads/1432.jpg
  93
  94 Installation
  95 ============
  96
  97 .. code-block:: shell
  98
  99     $ git clone --recursive https://github.com/lcpz/awesome-copycats.git
 100     $ mv -bv awesome-copycats/* ~/.config/awesome && rm -rf awesome-copycats
 101
 102 Usage
 103 =====
 104
 105 The modular structure allows to
 106
 107 * set variables
 108 * define startup processes
 109 * change keybindings and layouts
 110 * set client properties
 111
 112 in ``rc.lua``, and
 113
 114 * configure widgets
 115 * define wiboxes and screen settings
 116
 117 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.
 118
 119 Just do the following:
 120
 121 .. code-block:: shell
 122
 123     $ cd ~/.config/awesome
 124     $ cp rc.lua.template rc.lua
 125
 126 Then, set the variable ``chosen_theme`` in ``rc.lua`` to your preferred theme, do your settings, and restart Awesome (``Mod4 + ctrl + r``).
 127
 128 To customize a theme, head over to ``themes/$chosen_theme/theme.lua``.
 129
 130 Otherwise, if you want to be synced with upstream, modify the theme path in ``rc.lua`` like this:
 131
 132 .. code-block:: diff
 133
 134     -beautiful.init(string.format("%s/.config/awesome/themes/%s/theme.lua", os.getenv("HOME"), chosen_theme))
 135     +beautiful.init(string.format("%s/.config/awesome/themes/%s/theme-personal.lua", os.getenv("HOME"), chosen_theme))
 136
 137 then, copy ``theme.lua`` to ``theme-personal.lua`` and do your customizations there.
 138
 139 This way, you can safely ``git pull`` anytime.
 140
 141 Notes
 142 =====
 143
 144 Complements are provided by lain_ and freedesktop_. **Be sure** to satisfy their dependencies.
 145
 146 The fonts used in the screenshots are: Terminus_ (Multicolor, Powerarrow, Powerarrow Dark), Roboto_ (Holo, Vertex) and Tamsyn_ (other ones).
 147
 148 As taglist font, Blackburn and Dremora use Icons_, Vertex uses FontAwesome_: be sure to have bitmaps enabled if running under Debian or Ubuntu_.
 149
 150 Due the removal of support for bitmap fonts in Pango 1.44_, the current main font is Terminus (OTB version). Under Arch Linux, use ``community/terminus-font-otb``.
 151
 152 Every theme has a colorscheme_.
 153
 154 You can also configure the ``city_id`` in the following snippet in ``/.config/awesome/themes/<<CHOSEN_THEME>>/theme.lua`` to get the correct weather information (we suggest doing it in your ``theme-personal.lua``):
 155
 156 .. code-block::
 157
 158      -- Weather
 159         local weathericon = wibox.widget.imagebox(theme.widget_weather)
 160         theme.weather = lain.widget.weather({
 161             city_id = 2643743, -- placeholder (London)
 162             notification_preset = { font = "Terminus 10", fg = theme.fg_normal },
 163             weather_na_markup = markup.fontfg(theme.font, "#eca4c4", "N/A "),
 164             settings = function()
 165                 descr = weather_now["weather"][1]["description"]:lower()
 166                 units = math.floor(weather_now["main"]["temp"])
 167                 widget:set_markup(markup.fontfg(theme.font, "#eca4c4", descr .. " @ " .. units .. "°C "))
 168             end
 169         })
 170
 171 You can find your ``city_id`` in city.list.json.gz_ after you extract it.
 172
 173 Additional default software used: ::
 174
 175     dmenu firefox mpc mpd scrot unclutter xsel slock
 176
 177 .. _BY-NC-SA: http://creativecommons.org/licenses/by-nc-sa/4.0
 178 .. _b0ab0d7: https://github.com/lcpz/awesome-copycats/tree/b0ab0d7837987be81b9195a36631df773113d491
 179 .. _Awesome: http://github.com/awesomeWM/awesome
 180 .. _lucamanni: https://github.com/lucamanni/awesome
 181 .. _romockee: https://github.com/romockee/powerarrow
 182 .. _ok100: http://ok100.deviantart.com/art/DWM-January-2013-348656846
 183 .. _amouly: https://bbs.archlinux.org/viewtopic.php?pid=1307158#p1307158
 184 .. _swordfischer: https://github.com/lcpz/awesome-copycats/issues/53
 185 .. _foozer: http://dotshare.it/dots/499
 186 .. _lain: https://github.com/lcpz/lain
 187 .. _freedesktop: https://github.com/lcpz/awesome-freedesktop
 188 .. _Terminus: http://terminus-font.sourceforge.net
 189 .. _Tamzen: https://github.com/sunaku/tamzen-font
 190 .. _Roboto: https://fonts.google.com/specimen/Roboto
 191 .. _Tamsyn: http://www.fial.com/~scott/tamsyn-font
 192 .. _colorscheme: https://github.com/lcpz/dots/tree/master/.colors
 193 .. _Icons: https://github.com/lcpz/dots/tree/master/.fonts
 194 .. _Ubuntu: https://wiki.ubuntu.com/Fonts#Enabling_Bitmapped_Fonts
 195 .. _FontAwesome: https://github.com/FortAwesome/Font-Awesome
 196 .. _branches: https://github.com/lcpz/awesome-copycats/branches
 197 .. _city.list.json.gz: http://bulk.openweathermap.org/sample/city.list.json.gz
 198 .. _1.44: https://github.com/lcpz/awesome-copycats/issues/269