Commit 7f6b9a9c authored by Dominik Charousset's avatar Dominik Charousset

Link to codedocs.xyz for the API reference docs

parent 2e212dd9
# CAF: C++ Actor Framework # CAF: C++ Actor Framework
CAF is an open source C++11 actor model implementation featuring CAF is an open source implementation of the actor model for C++ featuring
lightweight & fast actor implementations, pattern matching for messages, lightweight & fast actor implementations, pattern matching for messages, network
network transparent messaging, and more. transparent messaging, and more.
[![Gitter][gitter-badge]](https://gitter.im/actor-framework/chat) [![Gitter][gitter-badge]](https://gitter.im/actor-framework/chat)
[![Jenkins][jenkins-badge]](https://jenkins.inet.haw-hamburg.de/job/CAF/job/actor-framework/job/master) [![Jenkins][jenkins-badge]](https://jenkins.inet.haw-hamburg.de/job/CAF/job/actor-framework/job/master)
...@@ -13,9 +13,8 @@ network transparent messaging, and more. ...@@ -13,9 +13,8 @@ network transparent messaging, and more.
* __Homepage__: http://www.actor-framework.org * __Homepage__: http://www.actor-framework.org
* __Developer Blog__: http://blog.actor-framework.org * __Developer Blog__: http://blog.actor-framework.org
* __Doxygen__: http://www.actor-framework.org/doc * __Manual__: https://actor-framework.readthedocs.io
* __HTML Manual__: https://actor-framework.readthedocs.io * __Doxygen__: https://codedocs.xyz/actor-framework/actor-framework
* __PDF Manual__: http://www.actor-framework.org/pdf/manual.pdf
## Report Bugs / Get Help ## Report Bugs / Get Help
...@@ -132,19 +131,17 @@ A SNocs workspace is provided by GitHub user ...@@ -132,19 +131,17 @@ A SNocs workspace is provided by GitHub user
* FreeBSD 10 * FreeBSD 10
* Windows >= 7 (currently static builds only) * Windows >= 7 (currently static builds only)
## Optional Dependencies ## Build Documentation Locally
* Doxygen (for the `doxygen` target) - Building an offline version of the manual requires
* LaTeX (for the `manual` target) [Sphinx](https://www.sphinx-doc.org):
```sh
## Build the Manual cd manual
sphinx-build . html
CAF uses [Sphinx](https://www.sphinx-doc.org): ```
- Building an offline version of the API reference documentation requires
```sh [Doxygen](http://www.doxygen.nl) (simply run the `doxygen` command at the
cd manual root directory of the repository).
sphinx-build . html
```
## Scientific Use ## Scientific Use
......
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