summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.txt62
1 files changed, 55 insertions, 7 deletions
diff --git a/README.txt b/README.txt
index 664946f..4e979c0 100644
--- a/README.txt
+++ b/README.txt
@@ -1,4 +1,4 @@
-apache-icons - alternative icons for Apache autoindex
+apache-icons - Alternative icons for Apache autoindex
=====================================================
@@ -15,7 +15,10 @@ apache-icons provides alternative icons for Apache autoindex.
2. Download
-----------
- * https://github.com/open-infrastructure/apache-icons
+ * Upstream Releases: https://files.open-infrastructure.net/software/apache-icons/upstream
+ * Upstream Sources: https://sources.open-infrastructure.net/software/apache-icons
+ * Debian Releases: https://files.open-infrastructure.net/software/apache-icons/debian
+ * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-apache-icons
3. Installation
@@ -24,24 +27,69 @@ apache-icons provides alternative icons for Apache autoindex.
3.1 Source
----------
- 1. sudo apt install imagemagick librsvg2-bin
- 2. git clone https://github.com/open-infrastructure/apache-icons
+ 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc imagemagick librsvg2-bin
+ 2. git clone https://sources.open-infrastructure.net/software/apache-icons
3. cd apache-icons && sudo make install
+3.2 Debian 9 (stretch) and newer
+--------------------------------
+
+ * sudo apt install apache-icons
+
4. Development
--------------
-Bug reports, feature requests, and patches are welcome via Github:
+Bug reports, feature requests, and patches are welcome via Debian Bug Tracking System:
- * https://github.com/open-infrastructure/apache-icons
+ * https://bugs.debian.org
Please base them against the 'next' Git branch using common sense:
* https://www.kernel.org/doc/Documentation/SubmittingPatches
-5. Authors
+5. Known Limitations
+--------------------
+
+Changing from one icon set to the other requires a reload of the apache webserver.
+
+
+6. Usage
+--------
+
+The default icon theme is determined by the /usr/share/apache-icons/default
+(and /usr/share/apache-icons/default.conf respectivly) file.
+
+On Debian based system "sudo update-alternatives --config apache-icons" can be
+used to automatically select the active icon theme (including the default apache
+icons).
+
+The following themes are available:
+
+ * awesome-png: Font Awesome based, PNG format
+ * awesome-svg: Font Awesome based, SVG format
+ * tango-png: Tango Icons based, PNG format
+ * tango-svg: Tango Icons based, SVG format
+
+The SVG themes are preferable because they are sharper and scale losless.
+They require somewhat modern browsers though.
+
+An example of the tango-svg theme can be seen on
+https://files.open-infrastructure.net.
+
+
+7. Links
+--------
+
+ * Font Awesome:
+ http://fontawesome.io/
+
+ * Tango Desktop Project:
+ http://tango.freedesktop.org/
+
+
+8. Authors
----------
* Daniel Baumann <daniel.baumann@open-infrastructure.net>