ewen/awesome-copycats
1
0
Fork 0
mirror of https://github.com/lcpz/awesome-copycats.git synced 2026-03-23 14:05:11 +00:00
Code Issues Projects Releases Wiki Activity

fix README

Browse source
This commit is contained in:
SirHadrian 2022-09-19 15:53:07 +03:00 committed by GitHub
parent dc10d674a0
commit 9a1a5fbca3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 120 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

239
README.rst
View file

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