summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README14
-rw-r--r--samples/Plugins/HelloWorld.hs (renamed from src/Plugins/HelloWorld.hs)0
-rw-r--r--samples/Plugins/helloworld.config (renamed from src/Plugins/helloworld.config)0
-rw-r--r--samples/xmobar.config (renamed from xmobar.config-sample)0
-rw-r--r--xmobar.cabal8
5 files changed, 13 insertions, 9 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 © 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
diff --git a/src/Plugins/HelloWorld.hs b/samples/Plugins/HelloWorld.hs
index df5cff6..df5cff6 100644
--- a/src/Plugins/HelloWorld.hs
+++ b/samples/Plugins/HelloWorld.hs
diff --git a/src/Plugins/helloworld.config b/samples/Plugins/helloworld.config
index 3818bfa..3818bfa 100644
--- a/src/Plugins/helloworld.config
+++ b/samples/Plugins/helloworld.config
diff --git a/xmobar.config-sample b/samples/xmobar.config
index b061459..b061459 100644
--- a/xmobar.config-sample
+++ b/samples/xmobar.config
diff --git a/xmobar.cabal b/xmobar.cabal
index da7d9e5..ebc2236 100644
--- a/xmobar.cabal
+++ b/xmobar.cabal
@@ -11,14 +11,11 @@ description: Xmobar is a minimalistic text based status bar.
category: System
license: BSD3
license-file: LICENSE
-extra-source-files: README, NEWS
author: Andrea Rossato
maintainer: Jose A. Ortega Ruiz <jao@gnu.org>
cabal-version: >= 1.6
build-type: Simple
-data-files: xmobar.config-sample
-
source-repository head
type: git
location: git://github.com/jaor/xmobar.git
@@ -51,6 +48,11 @@ flag all_extensions
description: Includes all optional extensions.
default: False
+data-files: samples/xmobar.config
+extra-source-files: README, NEWS,
+ samples/Plugins/helloworld.config,
+ samples/Plugins/HelloWorld.hs
+
executable xmobar
hs-source-dirs: src
main-is: Main.hs