Documentation update

This commit is contained in:
Simon Rozman 2016-06-14 12:38:46 +02:00
parent 5ce2d209d2
commit 02f69e332c

View File

@ -5,12 +5,39 @@ A Microsoft Windows application for composing texts using a wide range of Slavic
## Project Website ## Project Website
http://zrcola-2.amebis.si/en/ (Development version) http://zrcola-2.amebis.si/en/ (Development version)
## Binaries to Download ## Binaries for Download
https://www.amebis.si/prenos/ZRCola/ https://www.amebis.si/prenos/ZRCola/
##Building Environment Requirements ## Building
### Building Environment Requirements
- Microsoft Windows Vista or later - Microsoft Windows Vista or later
- Microsoft Visual Studio 2010 SP1 - Microsoft Visual Studio 2010 SP1
- _sed.exe_ and _grep.exe_ - _sed.exe_ and _grep.exe_
- Command line utilities from Microsoft Windows SDK Bin folder: distributed with Visual Studio, add Bin folder to path manually. - Command line utilities from Microsoft Windows SDK Bin folder: distributed with Visual Studio, add Bin folder to path manually.
- Additional command line utilities from projects bin folder: add bin folder to path. The source code is provided on request. - Additional command line utilities from projects bin folder: add bin folder to path. The source code is provided on request.
### Digital Signing of Build Outputs
In order to have the build process digitally sign output files, one should provide the following:
1. A signing certificate installed in the current users certificate store.
2. The following variables in the environment:
- _ManifestCertificateThumbprint_ - set the value to certificates SHA1 thumbprint (hexadecimal, without spaces, i.e. _bc0d8da45f9eeefcbe4e334e1fc262804df88d7e_).
- _ManifestTimestampUrl_ - set the value to URL used to perform timestamp signature (i.e. _http://timestamp.verisign.com/scripts/timstamp.dll_). In order to perform timestamp signing successfully, the computer running the build should be online and able to access this URL.
Please note that only Release builds are configured for timestamp signing. Debug configurations do not attempt to timestamp sign the resulting DLL and EXE files in order to speed up the building process and enable offline building.
### Building
Use Microsoft NMAKE to build the project. The resulting files can be found in output subfolder.
`nmake Clean` Delete all intermediate and output files.
`nmake Setup` Build a release version of project and release MSI setup files.
`nmake SetupDebug` Build a debug version of project and debug MSI setup files.
`nmake Register` Build a debug version of project, install fonts (reboot required), and Start Menu shortcuts. For development purposes only!
`nmake Unregister` Remove Start Menu shortcuts, and fonts. For development purposes only!
The /ls flag can be appended to the commands above to reduce NMAKEs verbosity. You can combine multiple targets (i.e. nmake Unregister Clean). Please, see NMAKE reference for further reading.
## Contact Information
Please contact the following addressee for further information and help:
- ZRC SAZU, Jamova ulica 39, 1000 Ljubljana, Slovenia, ZRCola@zrc-sazu.si
- Amebis, d. o. o., Kamnik, Bakovnik 3, 1230 Kamnik, Slovenia, info@amebis.si