Fixed typos and changed the binary directory for the installer from "installer" to "Installers", modifies the link posted in #1237

This commit is contained in:
Jorrit Wronski
2016-10-18 22:08:41 +02:00
parent 6f33115a20
commit 07f0b67c70
5 changed files with 40 additions and 6 deletions

View File

@@ -685,9 +685,9 @@ if (COOLPROP_WINDOWS_PACKAGE)
# Build the installer and copy it to the bin directory
add_custom_command(TARGET COOLPROP_WINDOWS_PACKAGE_INSTALLER POST_BUILD
COMMAND ${COOLPROP_WINDOWS_PACKAGE_ISS_EXE} ARGS "addin-installer.iss"
COMMAND ${CMAKE_COMMAND} ARGS "-E" "copy_directory" "${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/deploy" "${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/bin/installer/Windows"
COMMAND ${CMAKE_COMMAND} ARGS "-E" "copy_directory" "${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/deploy" "${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/bin/Installers/Windows"
WORKING_DIRECTORY "${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}"
COMMENT "The new installer is located in '${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/bin/installer/Windows'"
COMMENT "The new installer is located in '${COOLPROP_WINDOWS_PACKAGE_TMP_DIR}/bin/Installers/Windows'"
VERBATIM )
endif()

View File

@@ -9,8 +9,12 @@ EES is an acausal solver that can be used to solve a wide range of technical pro
Users
=====
Install
-------
Automated Installation
----------------------
As of October 2016, the EES wrapper can be installed from the Windows package as described on the :ref:`page on installation packages <Installers>`. Please refer to the documentation there for issues related to the installation process.
Manual Install
--------------
Pre-compiled binaries can be downloaded from :sfdownloads:`EES` - follow the instructions there. Of you can download an installer from the development preview at :sfnightly:`EES`.
Usage

View File

@@ -10,7 +10,7 @@ Pre-compiled Binaries for windows
Automated Installation
----------------------
As of October 2016, the Excel wrapper for Microsoft Windows can installed from the Windows package as described on the :ref:`page on installation packages <Installers>`. Please refer to the documentation there for issues related to the installation process on Windows.
As of October 2016, the Excel wrapper for Microsoft Windows can be installed from the Windows package as described on the :ref:`page on installation packages <Installers>`. Please refer to the documentation there for issues related to the installation process on Windows.
.. [#] If you get security warnings after you installed the CoolProp add-in, you can try adding the installation folder to your trusted directories: Got to ``File->Options->Trust Center->Trust Center Settings...->Trusted Locations`` and add the folder where your ``xlam``-file lives. This is most likely ``C:\Users\username\AppData\Roaming\Microsoft\AddIns\``.

View File

@@ -0,0 +1,29 @@
.. _Installers:
******************
Installer Packages
******************
.. warning:: We only have an installer for Windows and it is still under development. Please file an issue if you experience any problems with it.
Packaged binaries can be downloaded from :sfdownloads:`Installers`. Development binaries coming from the continuous integration server can be found at :sfnightly:`Installers`.
*****************
Windows Installer
*****************
Shared Libraries
================
The installer for Windows includes the shared libraries (dll) for 32bit (stdcall and cdecl calling conventions) and 64bit. The libraries are installed into the user's `AppData/CoolProp` folder and the is added to the user's search path for libraries and executables via the environment variable `%PATH%`.
Microsoft Excel
===============
The add-in for **Microsoft Excel** can also be installed from this package and it automatically determines which of the two available add-ins is needed. There is `CoolProp.xla` for Microsoft Office versions prior to version 2007 and `CoolProp.xlam` for more recent Office installations. The add-ins are installed into the user's add-in directory and they are activated by default. Please note that the Excel add-in includes the installation of some of the shared libraries. Upon installation, an example file is placed on the user's desktop. This file demonstrates some of the features of the Excel wrapper and can be moved or deleted freely, it will not be removed by the uninstaller. Have a look at the dedicated :ref:`page <Excel>` for more information.
Engineering Equation Solver
===========================
A custom library for the Engineering Equation Solver (EES) is also part of this package. The installer puts the files into `C:\EES32\Userlib\COOLPROP_EES` and you have to move them manually if you installed EES to another location. There is also an example file for EES that will be placed on the user's desktop. This file demonstrates some of the features of the Excel wrapper and can be moved or deleted freely, it will not be removed by the uninstaller. Have a look at the dedicated :ref:`page <EES>` for more information.

View File

@@ -132,4 +132,5 @@ and explicitly typing "agree" before closing. Then you can use the compiler from
SharedLibrary/index.rst
DelphiLazarus/index.rst
VB.net/index.rst
R/index.rst
R/index.rst
Installers/index.rst