Skip to content

Commit

Permalink
Merge pull request #7 from orftz/readme-fixes
Browse files Browse the repository at this point in the history
Further README fixes and clarification
  • Loading branch information
sboli committed Aug 26, 2011
2 parents 11db700 + 19a68a2 commit fd8e852
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
twmn
====
A notification system adapted to work with tiling window managers. `twmn` is 2 different tools:
A notification system for tiling window managers. `twmn` is two things:

`twmnc` is a command line tool to send notification requests to `twmnd`. You can also use `notify-send` for a similar purpose, even though `twmnc` is more powerful. See `twmnc --help` for more information.
`twmnc`: command line tool to send notifications to `twmnd`. You can also use `notify-send` for a similar purpose, but `twmnc` is more powerful. See `twmnc --help` for more information.

`twmnd` is the daemon listening to notification requests and showing them one after another. Its configuration is done in the INI format at `~/.config/twmn/twmn.conf`. The file is created with a default configuration when `twmnd` is launched for the first time.
`twmnd`: daemon listening to notification requests and showing them one after another. Configure it at `~/.config/twmn/twmn.conf`. The file is generated the first time `twmnd` is launched.

Notifications are shown in a one-line bar called the notification slide. They can be navigated through and activated with shortcuts. See `twmn.conf`.
Notifications are shown in a one-line bar called the notification slide. They can be navigated through and activated with shortcuts.

See `twmn.conf` for more information.


About twmn.conf
---------------
<pre>
[gui]
; Absolute position from the top-left corner of the slide. You may need it
; for a multi-screen setup. You still have to set position in order to choose
; the slide animation. If empty, twmnd will try to figure out where to display
; the slide according to your desktop size and the position value.
; Absolute position from the top-left corner of the slide. You may need it for a multi-screen setup.
; You still have to set position in order to choose the slide animation. If empty, twmnd will try
; to figure out where to display the slide according to your desktop size and the slide position.
absolute_position= ; Supported format: WxH. Width and Height being integers.

; Background color.
Expand Down Expand Up @@ -68,11 +69,11 @@ sound_command= ; Path to command. Leave empty for no sound.
; Modifiers shortcuts.
modifiers=Alt+ ; Up to three modifiers. Use with the following shortcuts.

; Shows the previous notification. Mouse wheel up does it too.previous=K
; Shows the previous notification. Mouse wheel up does it too.
previous=K

; Shows the next notification. If a modification is manually shown it will not
; be displayed again when twmnd process the notification stack. Mouse wheel up
; does it too.
; Shows the next notification. If a modification is manually shown it will not be displayed again
; when twmnd process the notification stack. Mouse wheel up does it too.
next=J

; Activates the notification. Runs the command defined at activate_command.
Expand All @@ -93,11 +94,11 @@ For [Arch Linux](http://www.archlinux.org/) users, `twmn` is [on the AUR](https:
Otherwise you can install `twmnd` and `twmnc` manually:

1. install `boost`, `qt` and `dbus` if they weren't before
1. `cd path/to/twmn`
2. `qmake` to generate a Makefile
3. `make` to compile
4. `sudo make install` will copy `twmnd` and `twmnc` under /usr/local/bin, make sure this folder is in your
`$PATH` environment variable. (export PATH="$PATH:/usr/local/bin")
5. add `twmnd` where it will be executed each time you login (ie. in your `.xinitrc`, `rc.conf`, etc)
2. `git clone https://github.com/sboli/twmn.git` to get `twmn`
3. `cd twmn/`
4. `qmake` to generate a Makefile
5. `make` to compile
6. `sudo make install` to install `twmnd` and `twmnc` in `/usr/local/bin`. Make sure this folder is in your `$PATH` environment variable. (`export PATH=$PATH:/usr/local/bin`)
7. for `twmnd` to be always running, add it to your `.xinitrc`, `rc.conf` or else

The `storage_notifier` example requires `dbus-python` to be installed. The `mpd_notifier` example requires `python-mpd` to be installed and running.

0 comments on commit fd8e852

Please sign in to comment.