INSTALL updated

This commit is contained in:
Kolan Sh 2014-02-19 13:15:19 +04:00
parent 3cedf1c280
commit 18290fa735
1 changed files with 83 additions and 3 deletions

86
INSTALL
View File

@ -1,5 +1,85 @@
Requirements
------------
LaTeX-struct Installation Build-Time Dependencies
=========================
To build and install LaTeX-struct, type the following commands. Vala: https://wiki.gnome.org/Projects/Vala
Gee: https://wiki.gnome.org/Projects/Libgee
CMake: http://www.cmake.org
NSIS (Win-only): http://nsis.sourceforge.net
Run-Time Dependencies
Gee: https://wiki.gnome.org/Projects/Libgee
Operation Systems
* GNU/Linux (Gentoo, Debian, etc.)
* MS Windows (Windows 5.1 aka XP)
* BSD-based (FreeBSD, OpenBSD, NetBSD, Mac OS X)
If you need support of one more OS, be free in writing of patches and sending
pull-requests to the mainstream.
Compilation
-----------
Compilation under GNU/Linux
$ mkdir build-gcc && cd build-gcc
$ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
$ make
Compilation under MS Windows
$ mkdir build-mingw && cd build-mingw
$ LANG=en
$ PKG_CONFIG_PATH=
$ PATH=/c/MinGW/lib:/c/MinGW/bin:$PATH
$ cmake -G "MSYS Makefiles" .. -DCMAKE_BUILD_TYPE=Release
$ make
Compilation under BSD-based.
TODO: add description here.
Packing/Installation
--------------------
Packing/Installation under GNU/Linux
$ cpack
Install using your favourite package manager.
Packing/Installation under MS Windows
$ cpack
Install using an executable generated by NSIS.
Packing/Installation under BSD-based
$ cpack
Install using your favourite package manager.
Testing
-------
Testing under GNU/Linux
$ LANG=en ctest
Automated tests for memory leaks:
$ LANG=en ctest -D NightlyMemCheck && grep definitely Testing/Temporary/LastDynamicAnalysis_*.log
Testing under MS Windows
$ LANG=en ctest
Automated tests for memory leaks are not available as far as Valgrind not
present on this platform.
Testing under BSD-based
$ LANG=en ctest