1
0
Fork 0
mirror of https://github.com/lcpz/awesome-copycats.git synced 2024-12-22 11:12:31 +00:00
awesome-copycats/README.rst

177 lines
5.4 KiB
ReStructuredText
Raw Normal View History

2013-03-30 23:05:50 +00:00
Awesome WM Copycats
2013-09-13 19:20:22 +00:00
===================
2013-03-30 22:28:06 +00:00
2017-01-06 12:57:01 +00:00
-------------------------
Themes for Awesome WM 4.x
-------------------------
2013-03-30 22:28:06 +00:00
:Author: Luca CPZ
:Version: git
2013-09-13 19:58:52 +00:00
:License: BY-NC-SA_
2017-10-07 11:10:43 +00:00
:Source: https://github.com/lcpz/awesome-copycats
2013-08-28 14:43:13 +00:00
2013-08-28 14:47:13 +00:00
Description
2013-10-08 13:48:33 +00:00
===========
2013-08-28 14:43:13 +00:00
2017-10-07 11:10:43 +00:00
A set of themes for the Awesome_ window manager, version 4.x.
2017-06-23 10:18:54 +00:00
See branches_ for previous versions.
2013-08-28 14:43:13 +00:00
2018-02-14 11:54:24 +00:00
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.
2017-01-14 18:12:15 +00:00
Features
========
2013-03-30 22:30:10 +00:00
2017-01-27 17:29:36 +00:00
- Modularity
2017-01-15 00:22:34 +00:00
- Autohide widgets
2017-01-28 14:41:34 +00:00
- Autostart windowless processes
2016-09-29 09:03:32 +00:00
- Fast MPD and volume shortcuts (first time this trick has been used in Awesome)
2017-08-14 16:37:07 +00:00
- Shortcuts for copying to the clipboard, toggle wiboxes, widgets popups, screenshots capture, moving and magnifying clients
- Quake drop-down terminal
2016-09-29 09:03:32 +00:00
- 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
2015-07-02 10:06:34 +00:00
- OpenWeatherMap integration
2013-09-13 19:20:22 +00:00
- Net carrier status notifier
2013-04-16 19:46:48 +00:00
- Symbolic tag names
2017-01-15 16:15:48 +00:00
- DWM-like textual layoutbox
2017-01-10 18:45:16 +00:00
- Cairo wibar
2013-08-21 15:26:08 +00:00
- Custom layouts
2013-07-26 21:10:34 +00:00
- No borders when there's only one visible client
2016-11-06 12:51:44 +00:00
- Freedesktop.org compliant menu and desktop icons
2013-08-31 13:25:09 +00:00
- Vi-like client focus
2013-09-13 19:20:22 +00:00
- Non-empty tag browsing
2017-01-15 00:22:34 +00:00
- On-the-fly useless gaps resize
2013-09-19 18:54:11 +00:00
- Dynamic tagging
2013-03-30 22:31:28 +00:00
2013-03-30 23:05:50 +00:00
Gallery
2013-08-31 13:25:09 +00:00
=======
2013-03-30 23:05:50 +00:00
2016-09-29 09:03:32 +00:00
**Multicolor**, inspired by lucamanni_
2013-03-27 13:45:15 +00:00
2013-09-13 19:58:52 +00:00
.. image:: http://dotshare.it/public/images/uploads/650.png
2013-03-27 13:45:15 +00:00
2017-03-03 11:58:57 +00:00
**Powerarrow**, porting of romockee_'s
.. image:: http://dotshare.it/public/images/uploads/1453.png
**Powerarrow Dark**
2013-03-27 13:45:15 +00:00
2017-02-13 12:34:16 +00:00
.. image:: http://dotshare.it/public/images/uploads/649.jpg
2013-03-27 13:45:15 +00:00
2017-01-06 10:27:40 +00:00
**Steamburn**, porting of ok100_'s dwm
2013-03-27 13:45:15 +00:00
2013-09-13 19:58:52 +00:00
.. image:: http://dotshare.it/public/images/uploads/648.png
2013-03-30 22:48:13 +00:00
2013-09-13 19:20:22 +00:00
**Blackburn**
2013-03-30 22:48:13 +00:00
2013-09-13 19:20:22 +00:00
.. image:: http://dotshare.it/public/images/uploads/553.png
2013-03-27 13:45:15 +00:00
2013-09-13 19:20:22 +00:00
**Dremora**
2013-07-06 15:54:28 +00:00
2013-09-14 12:43:19 +00:00
.. image:: http://dotshare.it/public/images/uploads/652.png
2013-07-06 15:54:28 +00:00
2013-09-13 19:20:22 +00:00
**Rainbow**
2013-07-26 21:10:34 +00:00
2013-09-13 19:58:52 +00:00
.. image:: http://dotshare.it/public/images/uploads/606.png
2013-07-26 21:10:34 +00:00
2016-09-29 09:03:32 +00:00
**Holo**, requested by amouly_
2013-08-02 17:39:41 +00:00
2017-01-14 18:13:29 +00:00
.. image:: http://dotshare.it/public/images/uploads/651.jpg
2013-08-02 17:39:41 +00:00
2016-09-29 09:03:32 +00:00
**Copland**, inspired by foozer_
2013-09-20 15:28:49 +00:00
2013-10-08 11:51:17 +00:00
.. image:: http://dotshare.it/public/images/uploads/655.png
2013-09-20 15:28:49 +00:00
2017-01-30 20:54:08 +00:00
**Vertex**, requested by swordfischer_
.. image:: http://dotshare.it/public/images/uploads/1432.jpg
2013-09-13 19:20:22 +00:00
Installation
============
2017-02-21 12:05:30 +00:00
.. code-block:: shell
$ git clone --depth 1 --recursive https://github.com/lcpz/awesome-copycats.git
$ mv -bv awesome-copycats/* ~/.config/awesome && rm -rf awesome-copycats
2013-09-13 19:58:52 +00:00
Usage
=====
2017-02-21 12:05:30 +00:00
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
2017-12-15 10:50:03 +00:00
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.
2017-02-21 12:05:30 +00:00
Just do the following:
.. code-block:: shell
2017-01-29 13:54:48 +00:00
2017-01-28 20:45:39 +00:00
$ 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``).
2017-01-28 20:45:39 +00:00
2017-10-27 08:27:08 +00:00
To customize a theme, head over to ``themes/$chosen_theme/theme.lua``.
2014-04-12 16:08:25 +00:00
Otherwise, if you want to be synced with upstream, modify the theme path in ``rc.lua`` like this:
2017-02-21 12:05:30 +00:00
.. 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))
2017-02-21 12:05:30 +00:00
then, copy ``theme.lua`` to ``theme-personal.lua`` and do your customizations there.
This way, you can safely ``git pull`` anytime.
2013-04-22 11:48:43 +00:00
Notes
2013-08-31 13:25:09 +00:00
=====
2013-08-28 14:43:13 +00:00
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_.
2019-08-20 13:54:41 +00:00
Every theme has a colorscheme_.
2017-12-15 10:50:03 +00:00
Additional default software used: ::
amixer dmenu librewolf mpc mpd scrot unclutter xbacklight xsel slock
2017-01-10 18:45:16 +00:00
.. _BY-NC-SA: http://creativecommons.org/licenses/by-nc-sa/4.0
.. _Awesome: http://github.com/awesomeWM/awesome
.. _branches: https://github.com/lcpz/awesome-copycats/branches
2016-09-29 09:03:32 +00:00
.. _lucamanni: https://github.com/lucamanni/awesome
2014-12-08 18:56:05 +00:00
.. _romockee: https://github.com/romockee/powerarrow
2013-03-27 13:45:15 +00:00
.. _ok100: http://ok100.deviantart.com/art/DWM-January-2013-348656846
2013-08-02 18:49:54 +00:00
.. _amouly: https://bbs.archlinux.org/viewtopic.php?pid=1307158#p1307158
2017-10-07 11:10:43 +00:00
.. _swordfischer: https://github.com/lcpz/awesome-copycats/issues/53
2017-01-10 18:45:16 +00:00
.. _foozer: http://dotshare.it/dots/499
2017-10-07 11:10:43 +00:00
.. _lain: https://github.com/lcpz/lain
2018-12-08 07:16:26 +00:00
.. _freedesktop: https://github.com/lcpz/awesome-freedesktop
2017-01-10 18:45:16 +00:00
.. _Terminus: http://terminus-font.sourceforge.net
.. _Roboto: https://fonts.google.com/specimen/Roboto
.. _Tamzen: https://github.com/sunaku/tamzen-font
2017-10-07 11:10:43 +00:00
.. _Icons: https://github.com/lcpz/dots/tree/master/.fonts
2017-01-15 16:29:45 +00:00
.. _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