summaryrefslogtreecommitdiffstats
path: root/images/README
diff options
context:
space:
mode:
Diffstat (limited to 'images/README')
-rw-r--r--images/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/images/README b/images/README
new file mode 100644
index 000000000..ec8391826
--- /dev/null
+++ b/images/README
@@ -0,0 +1,20 @@
+The images directory contains the following:
+ - a Makefile for building firmware and fpga images
+ - a CMake file for building an images package
+
+The Makefile and build systems for the images are probably Unix specific.
+Its best to build the images on a Unix system with standard build tools.
+The CMake package target will create an images package for your system.
+
+To build the images (unix):
+ make clean
+ make images
+
+To build the package (unix):
+ mkdir build
+ cd build
+ cmake -DCPACK_GENERATOR=<type> ../
+ make package
+
+The package generator types are described here:
+ http://www.cmake.org/Wiki/CMake:CPackPackageGenerators