summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorChad Versace <chad.versace@intel.com>2015-12-08 14:05:42 -0800
committerChad Versace <chad.versace@intel.com>2015-12-08 14:05:42 -0800
commit6d38f75bb38a2ed60c1dfb1c1f83685ad0c0fd23 (patch)
tree2cdac0654926515f36e2952d439b364b200694d5 /INSTALL
parentaeedec77548d92e6ec7466d4ba9d7fcd1e4e1be8 (diff)
INSTALL: Rename file
Rename file BUILDING to INSTALL. That's the file's standard name in GNU conventions.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL28
1 files changed, 28 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..7b3436b
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,28 @@
+How to Build
+============
+
+External Dependencies
+---------------------
+- Python 3
+- glslc, from Google's shaderc project (http://github.com/google/shaderc)
+- AsciiDoc (http://asciidoc.org)
+- ImageMagick (http://www.imagemagick.org/)
+
+
+Configure and Build
+-------------------
+Do the typical autotools dance:
+
+ $ autoreconf -vfi
+ $ ./configure
+ $ make
+
+The configure script will search for Vulkan headers and libraries in the usual
+system locations. You can modify the search paths with environment variables
+CPATH and LIBRARY_PATH [see man:gcc(1)].
+
+
+How to Install
+==============
+
+Sorry. Crucible does not yet support `make install`.