[Bf-blender-cvs] [ba0ef25] fluid-mantaflow: added readme

[Sebastián Barschkis]

Commit: ba0ef25670aab3be0a56697083e925e1b6d5e597
Author: Sebastián Barschkis
Date:   Tue Dec 22 03:40:15 2015 +0100
Branches: fluid-mantaflow
https://developer.blender.org/rBba0ef25670aab3be0a56697083e925e1b6d5e597

added readme

===================================================================

A	readme.md

===================================================================

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..21041b9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,90 @@
+## Build (for the impatient)
+
+### Mac OSX
+
+ 1. Get the official Blender code:
+        
+        $ mkdir blender-build
+        $ cd blender-build
+        $ git clone http://git.blender.org/blender.git
+        $ cd blender
+        $ git submodule update --init --recursive
+        $ git submodule foreach git checkout master
+        $ git submodule foreach git pull --rebase origin master
+        $ cd ..
+        $ mkdir lib
+        $ cd lib
+        $ svn checkout https://svn.blender.org/svnroot/bf-blender/trunk/lib/darwin-9.x.universal
+
+ 2. Play this github repo on top:
+        
+        $ cd ../blender
+        $ git remote add github https://github.com/sebbas/BlenderMantaflow.git
+        $ git pull github soc-2014-fluid
+
+ 3. Build the code!
+        
+        $ cd ..
+        $ mkdir build_darwin
+        $ cd build_darwin
+        $ cmake ../blender/ -DCMAKE_C_COMPILER=your_path/blender-build/lib/darwin-9.x.universal/clang-omp-3.5/bin/clang -DCMAKE_CXX_COMPILER=your_path/blender-build/lib/darwin-9.x.universal/clang-omp-3.5/bin/clang++
+        $ make
+        $ make install
+
+Run Blender from *your_path/build_darwin/bin/Blender.app*!
+
+### Linux
+
+ 1. Get the official Blender code:
+
+        $ mkdir blender-git
+        $ cd blender-git
+        $ git clone http://git.blender.org/blender.git
+        $ cd blender
+        $ git submodule update --init --recursive
+        $ git submodule foreach git checkout master
+        $ git submodule foreach git pull --rebase origin master
+
+ 2. Play this github repo on top:
+        
+        $ git remote add github https://github.com/sebbas/BlenderMantaflow.git
+        $ git pull github soc-2014-fluid
+
+ 3. Build the code!
+        
+        $ make
+
+## Build (with explanations)
+
+Since this repository relies on a working Blender building environment, the easiest way to set it up is to play it on top of the official Blender code. You can do so by following these steps:
+
+ 1. If you haven't already, download the latest Blender [code](http://wiki.blender.org/index.php/Dev:Doc/Building_Blender). If you have, then make sure that it is *up-to-date*! Make sure to *only get* the code, we will build later.  
+
+ 2. Navigate to the Blender source code directory and check out the *soc-2014-fluid* repository which contains the old Mantaflow integration:  
+
+         $ cd build-blender/blender
+         $ git checkout soc-2014-fluid
+
+
+ 3. Play this github repository, which contains the updated Mantaflow integration, on top. So still in the Blender source directory, you can do this by simply adding a new remote and pulling from there:  
+        
+        $ git remote add github https://github.com/sebbas/BlenderMantaflow.git
+        $ git pull github soc-2014-fluid
+
+ 3. Now build the code, preferably with CMake. You only need to make sure that your compiler supports OpenMP as the internal Mantaflow version relies on that.  
+
+ 3.1  **Linux**:
+Under Linux you should normally not not have any problems with the compiler as the default GNU compiler is readily available and supports OpenMP.
+
+ 3.2  **Mac OSX**:
+For Mac OSX you need to specify a compiler different from the default Clang compiler since that one unfortunately does not support OpenMP. Luckily, the *lib* directory from the SVN which you downloaded along with the source code, contains an OpenMP enabled compiler! Use it by telling CMake where to find it:
+
+        $ cmake ../blender/ -DCMAKE_C_COMPILER=your_path/blender-build/lib/darwin-9.x.universal/clang-omp-3.5/bin/clang -DCMAKE_CXX_COMPILER=your_path/blender-build/lib/darwin-9.x.universal/clang-omp-3.5/bin/clang++ 
+
+ 4. Finalise your build as you would when building the official Blender source code.
+
+
+## Examples
+
+Some fire renderings can be found on [Vimeo](https://vimeo.com/sebbas/videos). For the current development state, take a look at the latest videos!
+