From: Andrew Cooper <andrew.cooper3@citrix.com>
Date: Mon, 15 Feb 2016 15:33:23 +0000 (+0000)
Subject: Document the build requirements
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=ddd7ab504c324ec557bb876dc8f8fb175b9749bf;p=people%2Froyger%2Fxen-test-framework.git

Document the build requirements

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---

diff --git a/docs/mainpage.dox b/docs/mainpage.dox
index de7e211..bb80749 100644
--- a/docs/mainpage.dox
+++ b/docs/mainpage.dox
@@ -31,13 +31,18 @@ Environment | Guest | Width | Paging
 
 @section getting-started Getting Started
 
+Requirements:
+- GNU Make >= 3.81
+- GNU comaptible toolchain, capable of `-std=gnu99`, `-m64`, and `-m32`
+    - Clang may be used, via `CC="clang -no-integrated-as"`
+
 To obtain and build:
 
     $ git clone git://xenbits.xen.org/people/andrewcoop/xen-test-framework.git
     $ cd xen-test-framework
     $ make -j4
 
-To run tests: (see @ref errata first)
+To run tests on a Xen host: (see @ref errata first)
 
     # cd tests/example
     # xl create test-pv64-example.cfg