Skip to content

Commit

Permalink
Minor fixes in docs, setup and tox
Browse files Browse the repository at this point in the history
  • Loading branch information
cblegare committed Jun 1, 2017
1 parent 09a5559 commit e95f808
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,34 @@
Installation
============

`xdmenu` uses and needs an implementation of `dmenu`. This means a command
line program that reads lines from *stdin*, presents these lines to the user as
a menu and prints the chosen lines to *stdout*.

dmenu_
*dmenu is a dynamic menu for X, originally designed for dwm. It manages
large numbers of user-defined menu items efficiently.*

dmenu2_
*dmenu2 is the fork of original dmenu - an efficient dynamic menu for X,
patched with XFT, quiet, x & y, token, fuzzy matching, follow focus, tab
nav, filter.*

*Added option to set screen on which dmenu apperars, as long as opacity,
window class and window name. Also allows to dim screen with selected color
and opacity while dmenu2 is running.*

*Added underline color and height. (options -uc and -uh)*

Rofi_
*Rofi, like dmenu, will provide the user with a textual list of options
where one or more can be selected. This can either be, running an
application, selecting a window or options provided by an external script.*

.. _dmenu: http://tools.suckless.org/dmenu/
.. _dmenu2: https://bitbucket.org/melek/dmenu2
.. _Rofi: https://davedavenport.github.io/rofi/


Stable release
--------------
Expand Down
10 changes: 10 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Usage
=====

`xdmenu` is a wrapper API for `dmenu`_. The original use case of `xdmenu` was
to ease the integration of `dmenu` with `Qtile`_, a window manager written in
Python.

.. _dmenu: http://tools.suckless.org/dmenu/
.. _Qtile: http://www.qtile.org

The simplest possible usage of this wrapper is through the :func:`xdmenu.dmenu`
function.

Expand Down Expand Up @@ -32,4 +39,7 @@ using :meth:`xdmenu.BaseMenu.add_arg`
.. automethod:: xdmenu.BaseMenu.add_arg
:noindex:

`xdmenu` also provides a wrapper for `dmenu2`_. See :class:`xdmenu.Dmenu2`.

.. _dmenu2: https://bitbucket.org/melek/dmenu2

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def keywords(self):
provided for `basic usage
<http://setuptools.readthedocs.io/en/latest/setuptools.html?highlight=keywords#basic-use>`
"""
return ''
return 'dmenu, rofi, X, X11, UNIX, menu, window manager, Python, Qtile'

@property
def author(self):
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ envlist = py27, py33, py34, py35, pypy, pypy3
passenv = TOXENV CI TRAVIS TRAVIS_*
deps =
-rrequirements.txt
pytest
codecov>=1.4.0

commands =
Expand Down

0 comments on commit e95f808

Please sign in to comment.