summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf52f2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+Gnome-Pie
+======
+
+Feel free to visit its **homepage** at http://simmesimme.github.io/gnome-pie.html
+
+**Gnome-Pie** is a circular application launcher for Linux. It is made of several pies, each consisting of multiple slices. The user presses a key stroke which opens the desired pie. By activating one of its slices, applications may be launched, key presses may be simulated or files can be opened.
+
+
+## Installing from a PPA!
+
+There is a PPA with a recent version of Gnome-Pie. If you simply want to test it, it's very easy to install:
+
+~~~~
+sudo add-apt-repository ppa:simonschneegans/testing
+sudo apt-get update
+sudo apt-get install gnome-pie
+~~~~
+
+## Compiling and installing from source & Usage
+
+Please refer to the [guides on Gnome-Pie's homepage](http://simmesimme.github.io/gnome-pie.html)!
+
+## Support my work!
+
+I really like working on Gnome-Pie — and you can help improving it! There are multiple ways:
+
+### Translate Gnome-Pie!
+
+This is really easy: [There is an how-to available](http://simmesimme.github.io/lessons/2015/08/07/translate-gnome-pie/)!
+
+### Donate!
+
+If you can’t afford the time to do the stuff mentioned above, but still want to help — you can help improving this software by buying some drinks for a poor student ;) ! You can [do this with the Flattr](http://flattr.com/thing/468485/Gnome-Pie) or by [donating via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X65SUVC4ZTQSC). If you happen to dislike PayPal, send a mail to code@simonschneegans.de and we can chat about this!
+
+## License
+
+Copyright (C) 2011-2015 Simon Schneegans <code@simonschneegans.de>
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.