Commit 5e0357ac authored by Edward Vigmond's avatar Edward Vigmond

Update INSTALL.md

parent 49dc72d2
......@@ -5,12 +5,13 @@ Meshalyzer is regularly used on Linux and Mac machines. It has worked under Wind
## Prerequisities
1. [libpng](http://libpng.org)
2. [OpenMP](http://openmp.org) is recommended too improve certain operations. For all compilers except *clang* supplied by Apple. A simple way to include it on Apple machines is with homebrew:
2. [OpenMP](http://openmp.org) is recommended too improve certain operations. For all compilers, except *clang* supplied by Apple, it is standard. A simple way to include it on Apple machines is with homebrew:
`brew install libomp`
2. [FLTK 1.3.x](http://www.fltk.org/) or higher. Manually downloadad and installed is better since the prepackaged versions often have issues with fltk-config.
3. [glew](http://glew.sourceforge.net) for Linux and Windows only.
2. [glut](https://www.opengl.org/resources/libraries/glut/) for Linux and Windows only.
3. To make the "windowless" rendering version, [OSMesa](https://www.mesa3d.org/osmesa.html)
3. [cmake](https://cmake.org) if you want to make compiling easier.
3. <strike>To make the "windowless" rendering version, [OSMesa](https://www.mesa3d.org/osmesa.html)</strike>
4. To read in VTK/VTU format meshes, install [VTK](https://www.vtk.org/) development files
Except for fltk, using your package manager is recommended for installing these packages if possible. On *MacOS*, [homebrew](https://brew.sh/) works for us.
......@@ -52,7 +53,7 @@ We provide Makefiles and CMake files for compiling the code, choose the one that
### ccmake
For those who are familiar with ccmake:
For those who are familiar with [ccmake](https://cmake.org/cmake/help/v3.0/manual/ccmake.1.html):
1. `ccmake .`
......@@ -70,12 +71,14 @@ To compile the manual (LaTeX required)
## MacOS
Install the [prerequisities](#prerequisities) using your package manager. We use [homebrew](https://brew.sh/) as an example.
First of all, the [command line tools](https://developer.apple.com/download/more/?=command%20line%20tools) or [Xcode](https://developer.apple.com/xcode/) must be installed.
Next, install the [prerequisities](#prerequisities) using your package manager. We use [homebrew](https://brew.sh/) as an example.
```
brew install libpng
brew install fltk
brew install git
brew install cmake
```
Follow the steps in the [Compiling](#compiling) to build the code.
......@@ -100,10 +103,15 @@ apt-get update && apt-get install -y --no-install-recommends \
Follow the steps in [Compiling](#compiling) to build the code.
## Post-compilation
You can execute meshalyzer by typing `./meshalyzer`
To make meshalyzer available from anywhere on your machine, you need to copy it to your *bin* directory or
add the meshalyzer directory to **PATH** by editing your *.bashrc* or (*.bash_profile*). Type the following command into the terminal:
See README.md for an example.
To make meshalyzer available from anywhere on your machine, you need to copy it to your *bin* directory, or
add the meshalyzer directory to **PATH** by editing your *.bashrc* (or *.bash_profile*).
Using the nano editor as an example, type the following command into the terminal:
```
nano ~/.bashrc
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment