add a simple INSTALL guide

This commit is contained in:
Stephen Birarda 2016-01-20 11:41:55 -08:00
parent 3e5448612a
commit 1921aae08f

25
INSTALL.md Normal file
View file

@ -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).