readme stub in dev/

Basic description of how to build coolprop.
This commit is contained in:
Rod Persky
2014-05-16 16:48:28 +10:00
parent 89d566a2fc
commit df425fba4a

27
dev/README.md Normal file
View File

@@ -0,0 +1,27 @@
Building
====================
There are a number of ways to build the library:
Directly with Make
-------------------
There is a non-windows makefile in the wrappers/SharedLibrary that can be used to make the library.
With CMAKE
-----------
The platform independent cmake program can be used. In using cmake, CoolProp uses the standard procedure:
1) Make a build directory and cd to build
2) cmake ..
3) make
4) make
Although step 1 and 2 does depend on the OS, step 3 and 4 will depend on how the program is being built.
If on windows the cmake gui can be used which will perform steps 1 and 2, if using visual studio then
the build process will need to be run twice.
Make needs to be called twice, the first make step will dynamically generate a number of files from the
JSON fluid definitions - the second make run will actually generate the program.