dotfiles/awesome/freedesktop/README.rst
2018-02-21 09:19:00 +01:00

53 lines
1.9 KiB
ReStructuredText

Awesome-Freedesktop
===================
-------------------------------------------------------------------
Freedesktop.org menu and desktop icons support for Awesome WM 4.x
-------------------------------------------------------------------
:Original author: Antonio Terceiro
:Maintainer: Luke Bonham
:Version: git
:License: GNU-GPL2_
:Source: https://github.com/copycat-killer/awesome-freedesktop
Description
-----------
This is a port of awesome-freedesktop_ to Awesome_ 4.x.
**Note**: if you still have to use branch 3.5.x, you can refer to the commit 2c695a9_, but be aware that it's no longer supported.
Since the introduction of Menubar_ as core library for providing Freedesktop.org menu functionalities in Awesome,
we can now avoid all the dirty work by just exploiting ``menubar.utils`` functions.
At the initial status of this port, the menu is pretty much complete, while the desktop icons are very basic,
so the long term objective will be to complete functionalities on this part too.
More specifically, the todo list is:
- A better way to handle desktop icons path
- Ability to drag and line up icons
- Event-based signals, in particular:
- Updating trash icon according to its status
- Dynamic update (no need to restart Awesome to see changes on desktop)
Screenshot
----------
.. image:: screenshot.png
:align: center
:alt: Showcase of Freedesktop support in Awesome, using Adwaita icons
Installation and usage
----------------------
Read the wiki_.
.. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
.. _awesome-freedesktop: https://github.com/terceiro/awesome-freedesktop
.. _Awesome: https://github.com/awesomeWM/awesome
.. _2c695a9: https://github.com/copycat-killer/awesome-freedesktop/tree/2c695a922856e22d117cd80486d6ce67d79a72df
.. _Menubar: https://github.com/awesomeWM/awesome/tree/master/lib/menubar
.. _wiki: https://github.com/copycat-killer/awesome-freedesktop/wiki