From 1921aae08f1d812800672f869c8465af209bf84f Mon Sep 17 00:00:00 2001 From: Stephen Birarda Date: Wed, 20 Jan 2016 11:41:55 -0800 Subject: [PATCH] add a simple INSTALL guide --- INSTALL.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000000..4c35bed49b --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,25 @@ +Follow the [build guide](BUILD.md) to figure out how to build High Fidelity for your platform. + +During generation, CMake should produce an 'install' target and a 'package' target. + +###Install + +The `install` target will copy the High Fidelity targets and their dependencies to your CMAKE_INSTALL_PREFIX. + +###Packaging + +To produce an installer, run the `package` target. + +####Windows + +To produce an executable installer on Windows, the following are required: + +- [Nullsoft Scriptable Install System](http://nsis.sourceforge.net/Download) - 3.0b3 +- [UAC Plug-in for Nullsoft](http://nsis.sourceforge.net/UAC_plug-in) - 0.2.4c +- [nsProcess Plug-in for Nullsoft](http://nsis.sourceforge.net/NsProcess_plugin) - 1.6 + +Run the `package` target to create an executable installer using the Nullsoft Scriptable Install System. + +####OS X + +Run the `package` target to create an Apple Disk Image (.dmg).