summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKevin Bowen <kevin.bowen@gmail.com>2020-10-01 21:59:49 +0200
committerAndre Miranda <andreldm@xfce.org>2020-10-01 21:59:49 +0200
commit6d2ec8a86ce2ea02aa5c681153a0854d2d1f22bb (patch)
tree43ac21433ad2fb8303feb042df302375acb1ac06 /README.md
parent19fc5a60274a8b4370b8316782d5a3ead63d6ec5 (diff)
downloadthunar-volman-6d2ec8a86ce2ea02aa5c681153a0854d2d1f22bb.tar.gz
Adds new README.md updates AM_INIT_AUTOMAKE
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3dbc195
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+[![License](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://gitlab.xfce.org/xfce/thunar-volman/-/blob/master/COPYING)
+
+# thunar-volman
+
+
+Thunar-volman is an extension for the Thunar File Manager, which enables
+automatic management of removable drives and media. For example, if
+thunar-volman is installed and configured properly, and you plug in your
+digitcal camera, it will automatically spawn your preferred photo application
+and import the new pictures from your camera.
+
+It was designed to look and behave similar to gnome-volume-manager to get
+consistent removable drive and media management in Xfce and GNOME. This is
+to help GNOME refugees and people using both Xfce and GNOME (i.e. having to
+use GNOME at the office).
+
+----
+
+### Homepage
+
+[Thunar-volman documentation](https://docs.xfce.org/xfce/thunar-volman/start)
+
+### Changelog
+
+See [NEWS](https://gitlab.xfce.org/xfce/thunar-volman/-/blob/master/NEWS) for details on changes and fixes made in the current release.
+
+### Source Code Repository
+
+[Thunar-volman source code](https://gitlab.xfce.org/xfce/thunar-volman)
+
+### Download a Release Tarball
+
+[Thunar-volman archive](https://archive.xfce.org/src/xfce/thunar-volman)
+ or
+[Thunar-volman tags](https://gitlab.xfce.org/xfce/thunar-volman/-/tags)
+
+### Installation
+
+From source:
+
+ % cd thunar-volman
+ % ./autogen.sh
+ % make
+ % make install
+
+From release tarball:
+
+ % tar xf thunar-volman-<version>.tar.bz2
+ % cd thunar-volman-<version>
+ % ./configure
+ % make
+ % make install
+
+### Reporting Bugs
+
+Visit the [reporting bugs](https://docs.xfce.org/xfce/thunar-volman/bugs) page to view currently open bug reports and instructions on reporting new bugs or submitting bugfixes.
+