From 8bf82e5866ecd05f1e49685ad6474cb244477476 Mon Sep 17 00:00:00 2001 From: Kevin Fitch Date: Fri, 12 Jun 2015 19:24:59 -0400 Subject: [PATCH 1/2] Update README files to be a little more clear about testing. See issue #136. --- README.md | 11 +++++++++++ tests/math/README | 7 ++++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f4b75cb..7d8ae4f 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,17 @@ $ ./configure $ make ``` +Testing: +To run the automated unit tests you need to run +``` bash +$ make check +``` +For this to succeed you need to have the check unit test library (see http://check.sourceforge.net ) installed e.g. +``` bash +$ sudo apt-get install check +``` + + ##A Simple Example The following sample shows how to use PAL launch a simple task on a remote processor within the system. The program flow should be familiar to anyone who has used accelerator programming frameworks. diff --git a/tests/math/README b/tests/math/README index 6afaad2..ca9fea2 100644 --- a/tests/math/README +++ b/tests/math/README @@ -1,6 +1,8 @@ To add a new function to test suite -1.) Add line to run.sh with correct arguments -2.) Make sure entry is in test_main +1.) Update Makefile.am. You should need to add two lines, just follow the + examples of the existing tests. +2.) Create a reference implementation of the function. This will be in a file + like p_sin.c in this directory. 3.) Add a .dat file with comma separate columns. The last column contains the expected results @@ -8,6 +10,5 @@ STILL TODO: sort max min -sincos mode From 63d2932cf738f132458769fcff13e68eef5ed86c Mon Sep 17 00:00:00 2001 From: Ola Jeppsson Date: Sat, 13 Jun 2015 23:36:52 +0200 Subject: [PATCH 2/2] README: Don't Repeat Yourself Instead of repeating install instructions for 'check', add link to prerequisites. Signed-off-by: Ola Jeppsson --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7d8ae4f..9007d53 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,12 @@ Instructions for contributing can be found [HERE](CONTRIBUTING.md). ##Build Instructions -Install Pre-requisites: +###Install Prerequisites ``` bash $ sudo apt-get install libtool build-essential pkg-config autoconf doxygen check ``` -Build Sequence: +###Build Sequence ``` bash $ ./bootstrap @@ -70,15 +70,15 @@ $ ./configure $ make ``` -Testing: +###Testing + To run the automated unit tests you need to run ``` bash $ make check ``` -For this to succeed you need to have the check unit test library (see http://check.sourceforge.net ) installed e.g. -``` bash -$ sudo apt-get install check -``` + +For this to succeed you need to have the check unit test library (http://check.sourceforge.net). +See [prerequisites](#install-prerequisites). ##A Simple Example