summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Koleszar <jkoleszar@google.com>2012-06-20 14:45:22 -0700
committerJohn Koleszar <jkoleszar@google.com>2012-06-21 10:41:48 -0700
commit007486329fe79280f6b062a85fad9ba8720aaaea (patch)
treea408ee04b4fd8bde8b4a4adc386aa5db475d7790 /README
parent6fc1d9efc48abb360fa2b639afce6ac792769a8a (diff)
downloadlibvpx-007486329fe79280f6b062a85fad9ba8720aaaea.tar
libvpx-007486329fe79280f6b062a85fad9ba8720aaaea.tar.gz
libvpx-007486329fe79280f6b062a85fad9ba8720aaaea.tar.bz2
libvpx-007486329fe79280f6b062a85fad9ba8720aaaea.zip
Add support for downloading test data
The commit introduces a make target 'testdata' that downloads the required test data from the WebM project website. The data will also be downloaded if invoking `make test` but is not a strict requirement for only building the test executable. The download directory is taken from the LIBVPX_TEST_DATA_PATH environment variable, or may be specified as part of the make command. If unset, it defaults to the current directory. It's expected that most developers will want to set this environment variable to a place outside their source/build trees, to avoid having to download the data more than once. To add test data file: 1) add a line to test/test.mk: LIBVPX_TEST_DATA-yes += foo-bar-file.y4m 2) add its sha1sum to the test/test-data.sha1 file in the following format: 528cc88c821e5f5b133c2b40f9c8e3f22eaacc4c foo-bar-file.y4m 3) upload the file to the website $ gsutil cp foo-bar-file.y4m gs://downloads.webmproject.org/test_data/libvpx This implementation will check the integrity of the test data automatically if the `sha1sum` executable is available. Change-Id: If6910fe304bb3f5cdcc5cb9e5f9afa5be74720d2
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 10 insertions, 2 deletions
diff --git a/README b/README
index 0dfb0fe18..0475dad79 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
vpx Multi-Format Codec SDK
-README - 19 May 2010
+README - 21 June 2012
Welcome to the WebM VP8 Codec SDK!
@@ -15,11 +15,19 @@ COMPILING THE APPLICATIONS/LIBRARIES:
* Building the documentation requires PHP[3] and Doxygen[4]. If you do not
have these packages, you must pass --disable-install-docs to the
configure script.
+ * Downloading the data for the unit tests requires curl[5] and sha1sum.
+ sha1sum is provided via the GNU coreutils, installed by default on
+ many *nix platforms, as well as MinGW and Cygwin. If coreutils is not
+ available, a compatible version of sha1sum can be built from
+ source[6]. These requirements are optional if not running the unit
+ tests.
[1]: http://www.tortall.net/projects/yasm
[2]: http://www.cygwin.com
[3]: http://php.net
[4]: http://www.doxygen.org
+ [5]: http://curl.haxx.se
+ [6]: http://www.microbrew.org/tools/md5sha1sum/
2. Out-of-tree builds
Out of tree builds are a supported method of building the application. For
@@ -94,5 +102,5 @@ COMPILING THE APPLICATIONS/LIBRARIES:
SUPPORT
This library is an open source project supported by its community. Please
- please email webm-users@webmproject.org for help.
+ please email webm-discuss@webmproject.org for help.