Change README
Move README to docs/dunst.pod to be used as man page. Write a README with building instructions and dependencies. Remove INSTALL as it's no longer necessary.
This commit is contained in:
parent
d441e950d8
commit
dfdc082687
23
INSTALL
23
INSTALL
@ -1,23 +0,0 @@
|
|||||||
The following dependencies are needed:
|
|
||||||
|
|
||||||
dbus
|
|
||||||
libxinerama
|
|
||||||
libxft
|
|
||||||
libxss
|
|
||||||
libxdg-basedir
|
|
||||||
glib
|
|
||||||
pango/cairo
|
|
||||||
|
|
||||||
On Debian and Debian-based distros you'll probably also need the *-dev packages.
|
|
||||||
|
|
||||||
With all dependencies present you can build dunst with:
|
|
||||||
|
|
||||||
$ make
|
|
||||||
|
|
||||||
If you're getting compilation errors after an update try compiling
|
|
||||||
with the default config.h.
|
|
||||||
If you didn't edit your config.h you can just delete it.
|
|
||||||
|
|
||||||
and install with:
|
|
||||||
|
|
||||||
$ sudo make PREFIX=/usr install
|
|
2
Makefile
2
Makefile
@ -57,7 +57,7 @@ clean-doc:
|
|||||||
clean: clean-dunst clean-dunstify clean-doc test-clean
|
clean: clean-dunst clean-dunstify clean-doc test-clean
|
||||||
|
|
||||||
doc: dunst.1
|
doc: dunst.1
|
||||||
dunst.1: README.pod
|
dunst.1: docs/dunst.pod
|
||||||
pod2man --name=dunst -c "Dunst Reference" --section=1 --release=${VERSION} $< > $@
|
pod2man --name=dunst -c "Dunst Reference" --section=1 --release=${VERSION} $< > $@
|
||||||
|
|
||||||
service:
|
service:
|
||||||
|
46
README.md
Normal file
46
README.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
## Dunst
|
||||||
|
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Dunst is a highly configurable and lightweight notification daemon.
|
||||||
|
|
||||||
|
|
||||||
|
## Compiling
|
||||||
|
|
||||||
|
Dunst has a number of build dependencies that must be present before attempting configuration. The names are different depending on distribution:
|
||||||
|
|
||||||
|
- dbus
|
||||||
|
- libxinerama
|
||||||
|
- libxft
|
||||||
|
- libxss
|
||||||
|
- libxdg-basedir
|
||||||
|
- glib
|
||||||
|
- pango
|
||||||
|
- cairo
|
||||||
|
|
||||||
|
On Debian and Debian-based distros you'll probably also need the *-dev packages.
|
||||||
|
|
||||||
|
To build it:
|
||||||
|
```bash
|
||||||
|
cd dunst
|
||||||
|
make
|
||||||
|
sudo make PREFIX=/usr install
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Bug reports
|
||||||
|
|
||||||
|
Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug reports or feature requests.
|
||||||
|
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
written by Sascha Kruse <knopwob@googlemail.com>
|
||||||
|
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
copyright 2013 Sascha Kruse and contributors (see LICENSE for licensing information)
|
||||||
|
|
||||||
|
If you feel that copyrights are violated, please send me an email.
|
Loading…
x
Reference in New Issue
Block a user