aboutsummaryrefslogtreecommitdiffhomepage
path: root/INSTALLING
diff options
context:
space:
mode:
authorGravatar Dieter Plaetinck <dieter@plaetinck.be>2009-05-01 12:04:00 +0200
committerGravatar Dieter Plaetinck <dieter@plaetinck.be>2009-05-01 12:04:00 +0200
commitc3bfbeb956988417375aaf3f8876b29e090ae578 (patch)
tree6f8f1524b5936a045f6a8a4aa365311bb23a14a5 /INSTALLING
parenta77e1a4df94f2aceedf711f22027e283ee967b31 (diff)
improved INSTALLING FILE. used markdown syntax so we can use it on the site as well
Diffstat (limited to 'INSTALLING')
-rw-r--r--INSTALLING60
1 files changed, 43 insertions, 17 deletions
diff --git a/INSTALLING b/INSTALLING
index 0d10d24..654bde3 100644
--- a/INSTALLING
+++ b/INSTALLING
@@ -1,23 +1,49 @@
-* Arch Linux:
- pkgbuild @ http://aur.archlinux.org/packages.php?ID=25972
+Arch Linux
+----------
+[Arch Linux](http://www.archlinux.org) is our distro of choice, and the distro we use for testing.
-* From source:
+You can find a [PKGBUILD](http://aur.archlinux.org/packages.php?ID=25972) on the AUR, which installs the latest
+from the master branch. You can edit the PKGBUILD to change to any other
+branch you want.
-$ git clone git://github.com/Dieterbe/uzbl.git
-[ $ git checkout master/experimental ] # master == fairly stable. experimental is more bleeding edge
-$ cd uzbl
-$ make
-$ sudo make install
+From source
+-----------
+ $ git clone git://github.com/Dieterbe/uzbl.git
+ [ $ git checkout master/experimental ] # master == fairly stable. experimental is more bleeding edge
+ $ cd uzbl
+ $ make
+ $ sudo make install
-Dependencies:
-libwebkit 1.1.4 or higher
-gtk 2 something something
-pkgconfig (for Make/gcc)
+Dependencies
+------------
+* git (for building)
+* pkgconfig (for Make/gcc)
+* libwebkit 1.1.4 or higher
+* gtk 2 something something
-Optional:
-dmenu, zenity, bash for the sample scripts
+Optional/Recommended
+--------------------
+The following tools are quite useful, and some of them are used in the
+sample scripts:
-You will have the program in /usr/bin and various sample scripts, a sample config, sample bookmarks file and some documentation in /usr/share/uzbl. You
-will probably want to change the scripts to behave more like you want, so copy the scripts to your home dir. If you save your config as
-$XDG_CONFIG_HOME/uzbl/config (this expands to ~/.config/uzbl/config on most systems) it will be recognized automatically. You can also pass the path to
+* dmenu
+* zenity
+* bash
+
+File locations
+--------------
+After installing - using either method - you will find:
+
+* /usr/bin : uzbl [and uzblctrl]
+* /usr/share/uzbl/docs/ : documentation files included with uzbl. (readme, checklist,..)
+* /usr/share/uzbl/examples: sample scripts, config files and a sample bookmarks file.
+
+You will probably want to change the scripts to behave more like you want, so copy the scripts to your home dir. If you save your config as
+$XDG\_CONFIG\_HOME/uzbl/config (this expands to ~/.config/uzbl/config on most systems) it will be recognized automatically. You can also pass the path to
the config file with the --config parameter.
+
+You're free to store your personal stuff where you want, but we think the [XDG basedir spec](http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html)
+is very useful for keeping a clean home directory, so we recommend:
+
+* $XDG\_CONFIG\_HOME/uzbl/config* (~/.config/uzbl/config on most systems): config file
+* $XDG\_DATA\_HOME/uzbl (~/.local/share/uzbl on most systems): bookmarks file, history file. and "scripts" directory with scripts \ No newline at end of file