Merge remote-tracking branch 'origin/github/pr/145'

[grml-live.git] / README.md

diff --git a/README.md b/README.md
index cb18433..218b1bb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@ grml-live
 =========
 
 grml-live is a build system for creating a
-[Grml](http://grml.org/) and [Debian](http://www.debian.org/)
+[Grml](https://grml.org/) and [Debian](https://www.debian.org/)
 based Linux Live system. The build system is based on FAI ([Fully
-Automatic Installation](http://fai-project.org/)).
+Automatic Installation](https://fai-project.org/)).
 
 Building a Debian based 64bit live system is as simple as running:
 
@@ -13,5 +13,17 @@ Building a Debian based 64bit live system is as simple as running:
 You can fully customize the build process, including adding
 additional software and your very own configuration files.
 
-Further information is available from http://grml.org/grml-live/
+Further information is available from https://grml.org/grml-live/
 
+In case you want to run grml-live directly from the checkout
+(after making sure all dependencies are installed), you should
+set `GRML_FAI_CONFIG`, the `SCRIPTS_DIRECTORY`, the `LIVE_CONF`
+and the templates option so that it does not use the config files
+of an installed `grml-live` package:
+
+    # export GRML_FAI_CONFIG=$(pwd)/etc/grml/fai
+    # export SCRIPTS_DIRECTORY=$(pwd)/scripts
+    # export LIVE_CONF=$(pwd)/etc/grml/grml-live.conf
+    # export TEMPLATE_DIRECTORY=$(pwd)/templates
+    # ln -s ../../../grml-live-grml/templates/boot/addons templates/boot/  # optional
+    # ./grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64