Changeset d36146f in OpenModelica

Timestamp:

2020-10-21T14:04:18+02:00 (4 years ago)

Author:

Mahder Gebremedhin <mahder.gebremedhin@…>

Children:

b782523

Parents:

d4a68940

git-author:

Mahder Gebremedhin <mahder.gebremedhin@…> (10/19/20 16:48:41)

git-committer:

Mahder Gebremedhin <mahder.gebremedhin@…> (10/21/20 14:04:18)

Message:

[cmake] Update documentation.

File:

• OMCompiler/README.cmake.md (modified) (4 diffs)

OMCompiler/README.cmake.md

@@ -1 @@
-**_This an updated version of the PR #6648. That was reverted due to issues with compilation of simulationruntimemsvc target.  This fixes that and brings back the changes from the PR._**
 
+<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
+
+<!-- code_chunk_output -->
+
+- [Purpose](#purpose)
+- [Usage](#usage)
+  - [Build](#build)
+    - [Linux and Windows with OMDev MSYS](#linux-and-windows-with-omdev-msys)
+    - [Windows with other/fresh MSYS2](#windows-with-otherfresh-msys2)
+    - [Windows with Visual Studio Compiler](#windows-with-visual-studio-compiler)
+    - [MacOS](#macos)
+  - [Install](#install)
+- [Benefits](#benefits)
+- [Potential (Further improvement)](#potential-further-improvement)
+- [Progress](#progress)
+
+<!-- /code_chunk_output -->
+
+# Purpose
 This is an attempt to have a CMake configuration support for OMC. Right now the focus is in getting OMCompiler working.
 This is **half way done**. It is here just for early discussion. If it is deemed unnecessary it might be removed completely.
@@ -12 +30 @@
 
 ## Build
+### Linux and Windows with OMDev MSYS
 It is pretty straightforward cmake stuff.
+
 
 ```sh
@@ -31 +51 @@
 ```
 
-If you are on Linux like systems omc will check if it is in a folder whose path includes `/bin` or `/lib`. If it is not, it will tell you to update your OPENMODELICAHOME env variable.  Instead, you can just INSTALL the files as shown below or copy or move the generated omc into a folder called <something>/bin for now.
+**If you are on Linux like systems omc will check if it is in a folder whose path includes `/bin` or `/lib`. If it is not, it will tell you to update your OPENMODELICAHOME env variable.  Instead, you can just INSTALL the files as shown below or copy or move the generated omc into a folder called <something>/bin for now.**
 
-# Install
+### Windows with other/fresh MSYS2
+If you are using windows you can also use your own MSYS (non-OMDev) installation to build omc.  You can also use a fresh MSYS2 from https://www.msys2.org/.
 
-CMake uses a separate script (cmake_install.cmake) to perform installation. Since we are used to issuing 'make install' by default, CMake
-provides an specific built-in 'install' target. However, this target implies a **full build and full install**. That is you have no control on which parts you want to install. If this is what you want to do you can use that.
+Open a MINGW64 shell and install the dependencies needed to build omc.
+
+
+```sh
+# Install dependencies using pacman
+$ pacman -S make bison flex mingw-w64-x86_64-curl mingw-w64-x86_64-openblas
+```
+
+*Note that we install the MSYS version of `make`. The mingw32-make is not what you need here. Bison and flex are not strictly needed. They are only needed for building 3rdParty/lpsolve and that will be made optional soon*
+
+Then follow the same instructions as Linux/OMDev above.
+
+
+### Windows with Visual Studio Compiler
+Coming soon. There are two things to be decided/done
+
+  - Getting the needed Windows versions of OpenModelica dependencies to be used with VS.
+    - I am using vcpkg to manage the dependencies now and it seems to work fine.
+      However there will be discussions on if and which package manager OpenModelica chooses to use.
+
+      If you would like to try out the vcpkg version let me know.
+
+  - Fixing of compilation errors due to Linux/POSIX vs Windows differences in some system functions.
+
+### MacOS
+This will be next after Visual Studio.
+
+
+## Install
+
+CMake uses a separate script (cmake_install.cmake) to perform installation. Since we are used to issuing 'make install' by default, CMake provides a specific _built-in_ 'install' target. However, this target implies a **full build and full install**. That is, you have no control on which parts you want to install. If this is what you want to do you can use that.
 
 If you are working on just omc and do not need the whole set of *simulation runtime* libraries built and installed, there is a custom target `install_omc` provided which will build and install what is needed to run omc.
 
-```
+```sh
 # Build and Install just omc
-# $ make install_omc # For makefile generators
+$ make install_omc # For makefile generators
 # $ cmake --build <build_dir> --target install_omc # Generic usage.
 # $ cmake -DCOMPONENT=compiler -P cmake_install.cmake # The equivalent cmake_install invocation
 
 # Build and Install everything
-# $ make install # NOTE: This will first build everything. Not just omc.
+$ make install # NOTE: This will first build everything. Not just omc.
 # $ cmake --build <build_dir> --target install # Generic usage.
 # $ cmake -P cmake_install.cmake # The equivalent cmake_install invocation
@@ -54 +104 @@
 $ <install_dir>/bin/omc --help
 ```
-
-
-###### Installation can be buggy. It will be improved.
 
 # Benefits