summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSimon Steinbeiss <simon.steinbeiss@elfenbeinturm.at>2018-08-28 00:25:27 +0200
committerSimon Steinbeiss <simon.steinbeiss@elfenbeinturm.at>2018-08-28 00:26:13 +0200
commitac8ad5de03edd0668b74197fad8840a2a664daa7 (patch)
tree888ea6721c8ed61a5cd7c84ba3fb394f82cb2b35 /README.md
parent535ca5405ddecf4a81f02000ec4c16d799aac82c (diff)
downloadelementary-xfce-ac8ad5de03edd0668b74197fad8840a2a664daa7.tar.gz
Update the readme to reflect the added Makefile
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 92a4b543..fc590fb2 100644
--- a/README.md
+++ b/README.md
@@ -19,4 +19,29 @@ This is an icon-theme maintained with Xfce in mind, but it should work on other
It is a fork of the upstream [elementary project](http://elementary.io). The reason for forking was that the project decided to focus on its own desktop environment and dropped a ton of (ugly, but necessary) symlinks. This icon-theme is supposed to keep everything working, but gets updates from upstream occasionally.
-We'd like to encourage you to not only consider contributing to this, but also to the original icon-set. \ No newline at end of file
+We'd like to encourage you to not only consider contributing to this, but also to the original icon-set.
+
+## Installation
+
+You can use the Makefile to install the theme locally (default prefix is /usr/local).
+
+### Build dependencies
+- optipng
+
+### Installation for the current user only (without admin privileges)
+
+```
+./autogen.sh --prefix=$HOME/.local
+make
+make install
+make icon-caches
+```
+
+### Installation for all users
+
+```
+./autogen.sh
+make
+sudo make install
+sudo make icon-cache
+sudo make icon-caches