summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README80
1 files changed, 80 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..81ac7a4
--- /dev/null
+++ b/README
@@ -0,0 +1,80 @@
+####################################################################
+# Gnome-Pie #
+####################################################################
+
+This is an experimantal attempt to create a visual application
+launcher for the Gnome Desktop.
+
+Homepage: http://gnome-pie.simonschneegans.de
+
+It is inspired by the an addon written for the game World of Warcraft.
+(http://go-hero.net/opie/)
+
+####################################################################
+# About this Branch #
+####################################################################
+
+This is the master Branch of Gnome-Pie. A recent "stable" version
+will be in here.
+
+####################################################################
+# 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 #
+####################################################################
+
+First of all, install all dependancies:
+
+sudo apt-get install libgtk2.0-dev libcairo2-dev libappindicator-dev
+ libgee-dev libxml2-dev libxtst-dev
+ libgnome-menu-dev valac cmake libunique-dev
+
+Then build and launch Gnome-Pie by typing:
+
+./make.sh
+
+####################################################################
+# Usage #
+####################################################################
+
+Now you may launch it by Pressing <ctrl><Alt>A to open up a default
+Pie with your default applications. There are some other Pies
+defined --- just open up the configuration dialog by activating the
+appropriate entry in the appindicator menu or by launching gnome-pie
+for a second time. There you may configure the Pies to suit your
+needs.
+
+You can open Pies not only by presing their key stroke.
+Alternatively you may open any Pie by invoking gnome-pie --open 123
+where 123 is the ID of the desired Pie (which is displayed in the
+configuration dialog).
+
+####################################################################
+# License #
+####################################################################
+
+Copyright (C) 2011 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/>.
+
+