From 68daf840dbd832582c238eeeaeaed972b4abded8 Mon Sep 17 00:00:00 2001 From: Dieter Plaetinck Date: Sat, 11 Jul 2009 12:57:43 +0200 Subject: documentation fixes --- docs/CONTRIBUTING | 7 ++++--- docs/FAQ | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING index d7d7c94..14c3f0b 100644 --- a/docs/CONTRIBUTING +++ b/docs/CONTRIBUTING @@ -22,10 +22,10 @@ Read on for more info... ### Clone/patch/merge workflow 1. clone the code with git. - Either you host your git repo or yourself, or use something userfriendly + Either you host your git repo yourself, or use something userfriendly like [Github](http://www.github.com) If you want to use github, you basically just need to register and click - the fork button on (Dieterbe/uzbl)[http://github.com/Dieterbe/uzbl] + the fork button on [Dieterbe/uzbl](http://github.com/Dieterbe/uzbl) If you're new to Git/github, have no fear: * [Github guides (highly recommended)](http://github.com/guides/home) @@ -39,7 +39,8 @@ Read on for more info... 3. If you think your code should be in the main uzbl code and meets all requirements (see below), then ask Dieter to merge it. - * send a mail to the mailing list with subject "Pull request: " + + * send a mail to the mailing list with subject "`Pull request: <title>`" with a short description of your stuff and link to your git clone and which branch you're talking about. We prefer you send us links to git clones, and not just patches. They diff --git a/docs/FAQ b/docs/FAQ index 84f9a9f..b2a5c9c 100644 --- a/docs/FAQ +++ b/docs/FAQ @@ -5,6 +5,7 @@ FAQ Uzbl includes very limited default settings (statusbar settings, but no keybinds, history/download handlers etc.) Look at /usr/share/uzbl/docs/config.h to see the default settings. Have a look in /usr/share/uzbl/examples/configs to see what you can do. + If you save a config as $XDG\_CONFIG\_HOME/uzbl/config it will be loaded automatically. Running with the `--verbose` flag on a command line can also be interesting. To get you started, try this: @@ -16,6 +17,7 @@ If you like what you can do, you can copy the sample stuff into your ~ and edit ### Why don't you just use a reasonable config by default? We actually did some attempts to make uzbl "usable by default" but in the end we had to conclude it cannot be done because of the following reasons: + * We don't want to store anything "automagically" in the users home. Some people prefer different file/directory layouts, most of just want to control the files in $HOME themselves. -- cgit v1.2.3