summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2010-12-21 12:19:30 +0100
committerJose Antonio Ortega Ruiz <jao@gnu.org>2010-12-21 12:19:30 +0100
commit905edcbe535f0270cfae8e66e927a1e1ed49b89a (patch)
treecd31ee34d4967d8cafaf5b0ca05f2d50fbd2ccc5 /README
parent35ff8860c6018bc613af96247cba84c6abb3e517 (diff)
downloadxmobar-905edcbe535f0270cfae8e66e927a1e1ed49b89a.tar.gz
xmobar-905edcbe535f0270cfae8e66e927a1e1ed49b89a.tar.bz2
Samples moved to samples/
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 8 insertions, 6 deletions
diff --git a/README b/README
index 4abba31..9b9b9f7 100644
--- a/README
+++ b/README
@@ -6,7 +6,7 @@ About
xmobar is a minimalistic, text based, status bar. It was originally
designed and implemented by Andrea Rossato to work with [xmonad],
-but it's actually window-manager-agnostic.
+but it's actually usable with any window-manager.
xmobar was inspired by the [Ion3] status bar, and supports similar
features, like dynamic color management, output templates, and
@@ -127,7 +127,9 @@ Configuration
## Quick Start
-See [xmobar.config-sample] for an example.
+See [samples/xmobar.config] for an example.
+
+[samples/xmobar.config]: http://github.com/jaor/xmobar/raw/master/samples/xmobar.config
For the output template:
@@ -836,13 +838,14 @@ configuration options.
This requires importing your plugin into `Config.hs` and adding your
type to the type list in the type signature of `Config.runnableTypes`.
-For a very basic example see `Plugins/HelloWorld.hs` or the other
-plugins that are distributed with xmobar.
+For a very basic example see `samples/Plugins/HelloWorld.hs` or the
+other plugins that are distributed with xmobar.
## Installing/Removing a Plugin
Installing a plugin should require 3 steps. Here we are going to
-install the HelloWorld plugin that comes with xmobar:
+install the HelloWorld plugin that comes with xmobar, assuming that
+you copied it to `src/Plugins`:
1. import the plugin module in `Config.hs`, by adding:
@@ -974,4 +977,3 @@ Copyright &copy; 2010 Jose Antonio Ortega Ruiz
[libmpd]: http://hackage.haskell.org/package/libmpd/
[sawfish]: http://sawfish.wikia.com/
[utf8-string]: http://hackage.haskell.org/package/utf8-string/
-[xmobar.config-sample]: http://github.com/jaor/xmobar/raw/master/xmobar.config-sample