Commit 85e06cd6 authored by Dominik Charousset's avatar Dominik Charousset

Add Bii and Homebrew guides

parent f1b1d652
......@@ -23,12 +23,61 @@ network transparent messaging, and more.
* __Mailing List__: https://groups.google.com/d/forum/actor-framework
* __Chat__: https://gitter.im/actor-framework/chat
## Get CAF
### Homebrew
You can install the latest stable release with:
```
brew install caf
```
Alternatively, you can use the development branch by using:
```
brew install caf --HEAD
```
### Biicode
The official CAF channel is published under
[caf_bot/actor-framework](https://www.biicode.com/caf_bot/actor-framework)
and includes the following blocks:
* libcaf_core
* libcaf_io
* libcaf_riac
* libcaf_opencl (*depends on OpenCL which is not distributed as part of CAF*)
**NOTE:** You do not need to have CAF installed on your
machine. Biicode will automatically do that for you during the build process.
Visit this the [bii guide](http://docs.biicode.com/c++/gettingstarted.html)
for more information.
To use actor-framework in your project, reference the header file as:
`#include "caf_bot/actor-framework/libcaf_core/caf/all.hpp"`. Then run
`bii find` to resolve and download the files and `bii build`
to compile your code.
To avoid specifying the block name in your includes add the following to your
`bii.conf` file to allow Biicode to associate all `#include "caf/*.hpp"`
with the actor-framework block:
```
[includes]
caf/riac/*.hpp : caf_bot/actor-framework/libcaf_riac
caf/opencl/*.hpp : caf_bot/actor-framework/libcaf_opencl
caf/io/*.hpp : caf_bot/actor-framework/libcaf_io
caf/*.hpp : caf_bot/actor-framework/libcaf_core
```
## Get the Sources
* git clone https://github.com/actor-framework/actor-framework.git
* cd actor-framework
## Build CAF
## Build CAF from Source
The easiest way to build CAF is to use the `configure` script. Other available
options are using [CMake](http://www.cmake.org/) directly or
......
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