doc: Add user-guide.txt
atm it's just a stub, containing only Library environment variables
section and Colorized output (moved from colorized-output.txt).
Acked-by: Cyril Hrubis <chrubis@suse.cz>
Signed-off-by: Petr Vorel <pvorel@suse.cz>
diff --git a/README.md b/README.md
index b406a4a..e5eda3c 100644
--- a/README.md
+++ b/README.md
@@ -165,6 +165,9 @@
limited to shell scripts, many C based tests need environment variables as
well.
+For more info see `doc/user-guide.txt` or online at
+https://github.com/linux-test-project/ltp/wiki/User-Guidelines.
+
Developers corner
=================
diff --git a/doc/colorized-output.txt b/doc/colorized-output.txt
deleted file mode 100644
index c1859cc..0000000
--- a/doc/colorized-output.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-Colorized output
-================
-
-1. Usage
---------
-By default LTP colorizes it's output unless using pipe or redirect to file.
-
-It's possible to force behaviour with LTP_COLORIZE_OUTPUT environment variable:
-y or 1: always colorize
-n or 0: never colorize
diff --git a/doc/user-guide.txt b/doc/user-guide.txt
new file mode 100644
index 0000000..8913c32
--- /dev/null
+++ b/doc/user-guide.txt
@@ -0,0 +1,29 @@
+LTP User Guidelines
+===================
+
+For compiling and installing and running the tests see `README.md`.
+For running LTP network tests see `testcases/network/README.md`.
+
+1. Library environment variables
+--------------------------------
+
+|==============================================================================
+| 'KCONFIG_PATH' | The path to the kernel config file, (if not set, it tries
+ the usual paths '/boot/config-RELEASE' or '/proc/config.gz').
+| 'LTPROOT' | Prefix for installed LTP, the default is '/opt/ltp'.
+| 'LTP_COLORIZE_OUTPUT' | Force colorized output behaviour. 'y' or '1': always colorize
+ 'n' or '0': never colorize.
+| 'LTP_TIMEOUT_MUL' | Multiply timeout, must be number >= 1 (> 1 is useful for
+ slow machines to avoid unexpected timeout).
+ Variable is also used in shell tests.
+| 'PATH' | It's required to addjust path:
+ `PATH="$PATH:$LTPROOT/testcases/bin"`
+| 'TMPDIR' | Base directory for template directory, which is required by C tests
+ `tst_test->needs_tmpdir=1` (or others) or shell 'TST_NEEDS_TMPDIR=1').
+|==============================================================================
+
+2. Colorized output
+-------------------
+
+By default LTP colorizes it's output unless using pipe or redirect to file.
+It's possible to force behaviour with 'LTP_COLORIZE_OUTPUT' environment variable.
