Skip to content

Commit

Permalink
Added header moduoe to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jowr committed Nov 14, 2017
1 parent b33e512 commit ce3f266
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ option(IF97_HEADER_MODULE "Install header file only" OFF)
option(IF97_CMAKE_MODULE "Install CMake interface library" OFF)
option(IF97_FLAG "Skip IF97 test executable" OFF)

list(APPEND options ${IF97_PRIME_MODULE} ${IF97_MATHCAD15_MODULE} ${IF97_CMAKE_MODULE} ${IF97_FLAG})
list(APPEND options ${IF97_PRIME_MODULE} ${IF97_MATHCAD15_MODULE} ${IF97_HEADER_MODULE} ${IF97_CMAKE_MODULE} ${IF97_FLAG})
set(options_count 0)
foreach(option_value ${options})
if(option_value)
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,15 @@ This will spit out the values for the computer-program verification, they should
Accessing IF97 from your software
---------------------------------

The simplest way to include IF97 in your project is o simply copy the header file. If you are looking for an installation command, you can use `cmake .. -DIF97_HEADER_MODULE=ON; cmake --build . --target install`.

There is a `wrapper` directory for 3rd party applications, including:
- [Mathcad 15](wrapper/Mathcad) (Jeff Henning main contributor)
- [Mathcad Prime](wrapper/Mathcad) (Jeff Henning main contributor)

See the README in each wrapper directory for instructions on building and installing each.

Furthermore, there is an interface library target that installs the header file. This target can also be digested by other CMake-based projects using the `add_subdirectory` command. Enable it with the CMake option `cmake .. -DIF97_CMAKE_MODULE=ON`.
Furthermore, there is an interface library target that installs the header file. This target can also be digested by other CMake-based projects using the `add_subdirectory` command. Enable it with the CMake option `cmake .. -DIF97_CMAKE_MODULE=ON; cmake --build . --target install`.


Compiler Switches
Expand Down

0 comments on commit ce3f266

Please sign in to comment.