From 3733991c9a66ebd6d29b43bd065de278fb39e196 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 25 Apr 2014 15:35:02 +0100 Subject: README: Document how to build The build process for risu is a bit more complex now we have a configure script, so describe it in the README. Signed-off-by: Peter Maydell --- README | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index ded39e9..68719ee 100644 --- a/README +++ b/README @@ -9,6 +9,24 @@ mode. risu is also the Japanese word for squirrel. +Building +-------- + +risu comes in two parts -- a perl script 'risugen' for generating +test blobs (which can be run anywhere), and a Linux executable +'risu' which runs on the target architecture (ie ARM). To +build the executable part: + + [VAR=VALUE] ... ./configure + make + +where [VAR=VALUE] ... allows you to specify any options. +Most useful is + CROSS_PREFIX= which specifies the cross compiler prefix; you'll + need this if you're not building on the target system + (Example: CROSS_PREFIX=arm-linux-gnueabihf- ) +For other possibilities run 'configure --help'. + Usage ----- @@ -30,9 +48,9 @@ based on the instruction patterns matching the regular expression "VQSHL.*imm.*". The resulting binary is written to vqshlimm.out. This binary can then be passed to the risu program, which is -written in C. (Build it by running 'make'.) You need to run risu -on both an ARM native target and on the program under test. The -ARM native system is the 'master' end, so run it like this: +written in C. You need to run risu on both an ARM native target +and on the program under test. The ARM native system is the 'master' +end, so run it like this: ./risu --master vqshlimm.out -- cgit v1.2.3