summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKevin Bowen <kevin.bowen@gmail.com>2020-10-05 00:58:17 +0200
committerSimon Steinbeiß <ochosi@xfce.org>2020-10-05 00:58:17 +0200
commit52f86a0433671400ffae3570668736c6eae593a1 (patch)
treeda4a4dae180168059143076ab4e610acb0da3cfb /README.md
parent258844f1f055a4b506cd2aa14830127d316d79ab (diff)
downloadixfce4-power-manager-52f86a0433671400ffae3570668736c6eae593a1.tar.gz
Add README.md
Also update AM_INIT_AUTOMAKE
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..23c41e17
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+[![License](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://gitlab.xfce.org/xfce/xfce4-power-manager/-/blob/master/COPYING)
+
+# xfce4-power-manager
+
+Xfce4-power-manager manages the power sources of the computer and connected
+devices (wireless mice, keyboards, media players etc.). It also allows users
+to control the display backlight brightness and set power-saving modes for
+displays and monitors.
+In addition, xfce4-power-manager provides a set of freedesktop-compliant DBus
+interfaces to inform other applications about the current power level so that
+they can adjust their power consumption.
+
+----
+
+### Homepage
+
+[Xfce4-power-manager documentation](https://docs.xfce.org/xfce/xfce4-power-manager/start)
+
+### Changelog
+
+See [NEWS](https://gitlab.xfce.org/xfce/xfce4-power-manager/-/blob/master/NEWS) for details on changes and fixes made in the current release.
+
+### Source Code Repository
+
+[Xfce4-power-manager source code](https://gitlab.xfce.org/xfce/xfce4-power-manager)
+
+### Download a Release Tarball
+
+[Xfce4-power-manager archive](https://archive.xfce.org/src/xfce/xfce4-power-manager)
+ or
+[Xfce4-power-manager tags](https://gitlab.xfce.org/xfce/xfce4-power-manager/-/tags)
+
+### Installation
+
+From source:
+
+ % cd xfce4-power-manager
+ % ./autogen.sh
+ % make
+ % make install
+
+From release tarball:
+
+ % tar xf xfce4-power-manager-<version>.tar.bz2
+ % cd xfce4-power-manager-<version>
+ % ./configure
+ % make
+ % make install
+
+### Reporting Bugs
+
+Visit the [reporting bugs](https://docs.xfce.org/xfce/xfce4-power-manager/bugs) page to view currently open bug reports and instructions on reporting new bugs or submitting bugfixes.