Commit 315c41e9 authored by Dominik Charousset's avatar Dominik Charousset

Update README.md

parent c0970dcb
CAF: C++ Actor Framework
========================
# CAF: C++ Actor Framework
[![Jenkins][jenkins-badge]](http://mobi39.cpt.haw-hamburg.de/view/CAF%20Dashboard)
[![Gitter][gitter-badge]](https://gitter.im/actor-framework/chat)
[jenkins-badge]: http://mobi39.cpt.haw-hamburg.de/buildStatus/icon?job=CAF/master%20branch
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[![Jenkins][jenkins-badge]]
(http://mobi39.cpt.haw-hamburg.de/view/CAF%20Dashboard)
[![Gitter][gitter-badge]]
(https://gitter.im/actor-framework/chat)
[jenkins-badge]:
http://mobi39.cpt.haw-hamburg.de/buildStatus/icon?job=CAF/master%20branch
[gitter-badge]:
https://badges.gitter.im/Join%20Chat.svg
CAF is an open source C++11 actor model implementation featuring
lightweight & fast actor implementations, pattern matching for messages,
network transparent messaging, and more.
On the Web
----------
## On the Web
* __Homepage__: http://www.actor-framework.org
* __Developer Blog__: http://blog.actor-framework.org
......@@ -22,68 +23,79 @@ On the Web
* __Mailing List__: https://groups.google.com/d/forum/actor-framework
* __Chat__: https://gitter.im/actor-framework/chat
Get the Sources
---------------
## Get the Sources
* git clone https://github.com/actor-framework/actor-framework.git
* cd actor-framework
## Build CAF
The easiest way to build CAF is to use the `configure` script. Other available
options are using [CMake](http://www.cmake.org/) directly or
[SNocs](https://github.com/airutech/snocs).
First Steps
-----------
### Using the `configure` Script
* ./configure
* make
* make install [as root, optional]
The script is a convenient frontend for `CMake`. See `configure -h`
for a list of available options or read the
[online documentation]
(https://github.com/actor-framework/actor-framework/wiki/Configure-Options).
It is recommended to run the unit tests as well.
```
./configure
make
make test
make install [as root, optional]
```
* make test
### Using CMake
Please submit a bug report that includes (a) your compiler version, (b) your OS,
and (c) the content of the file build/Testing/Temporary/LastTest.log
if an error occurs.
All available CMake variables are available
[online](https://github.com/actor-framework/actor-framework/wiki/CMake-Options).
CAF also can be included as CMake submodule or added as dependency to other
CMake-based projects using the file `cmake/FindCAF.cmake`.
### Using SNocs
Dependencies
------------
A SNocs workspace is provided by GitHub user
[osblinnikov](https://github.com/osblinnikov) and documented
[online](https://github.com/actor-framework/actor-framework/wiki/Using-SNocs).
## Dependencies
* CMake
* Pthread (until C++11 compilers support the new `thread_local` keyword)
Supported Compilers
-------------------
## Supported Compilers
* GCC >= 4.7.2
* Clang >= 3.2
Supported Operating Systems
---------------------------
## Supported Operating Systems
* Linux
* Mac OS X
* FreeBSD 10
* *Note for MS Windows*: CAF relies on C++11 features such as variadic templates and unrestricted unions. We will support Visual Studio as soon as Microsoft's compiler implements all required C++11 features. In the meantime, you can use CAF via MinGW.
* *Note for MS Windows*: CAF relies on C++11 features such as variadic templates
and unrestricted unions. We will support Visual Studio as soon as Microsoft's
compiler implements all required C++11 features. In the meantime, you can
use CAF via MinGW.
Scientific Use
--------------
## Scientific Use
If you use CAF in a scientific context, please use the following citation:
```
@inproceedings{cshw-nassp-13,
author = {Dominik Charousset and Thomas C. Schmidt and Raphael Hiesgen and Matthias W{\"a}hlisch},
title = {{Native Actors -- A Scalable Software Platform for Distributed, Heterogeneous Environments}},
booktitle = {Proc. of the 4rd ACM SIGPLAN Conference on Systems, Programming, and Applications (SPLASH '13), Workshop AGERE!},
@inproceedings{chs-ccafs-14,
author = {Dominik Charousset and Raphael Hiesgen and Thomas C. Schmidt},
title = {{CAF - The C++ Actor Framework for Scalable and Resource-efficient Applications}},
booktitle = {Proc. of the 5th ACM SIGPLAN Conf. on Systems, Programming, and Applications (SPLASH '14), Workshop AGERE!},
month = {Oct.},
year = {2013},
year = {2014},
publisher = {ACM},
address = {New York, NY, USA},
location = {Portland, OR},
}
```
You will find the paper on http://dx.doi.org/10.1145/2541329.2541336
You will find the paper online at http://dx.doi.org/10.1145/2687357.2687363
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