forked from crossbario/autobahn-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alexander Goedde
committed
May 14, 2016
1 parent
4da92fb
commit 34758a5
Showing
15 changed files
with
96 additions
and
929 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,16 @@ | ||
# Documentation | ||
|
||
The **Autobahn**|JS documentation is generated using [Sphinx](http://sphinx.pocoo.org/) and the generated documentation is hosted [here](http://autobahn.ws/js). | ||
If you're new to Autobahn|JS, then please take a look at [Getting Started](gettingstarted.md) first. | ||
|
||
You may also want to read up a bit on the [Web Application Messaging Protocol (WAMP)](http://wamp-proto.org/why/) which it implements. | ||
|
||
## Generate | ||
And finally, we suggest visiting the [Crossbar.io site](http://crossbar.io). Crossbar.io is a WAMP router maintained by the people behind Autobahn|JS, and the documentation there includes examples for some aspects of building WAMP applications - all of which use Autobahn|JS. | ||
|
||
You will need to have Python and [SCons](http://www.scons.org/) installed. To install the rest of the build dependencies | ||
## Table of Contents | ||
|
||
```sh | ||
make install_deps | ||
``` | ||
|
||
|
||
Then, to get help on available build targets, just type | ||
|
||
```sh | ||
make | ||
``` | ||
* [Getting Started](gettinstarted.md) | ||
* [Programming](programming.md) - A quick introduction to using Autobahn|JS in your applications | ||
* [Reference](reference.md) - A full reference to the Autobahn|JS API | ||
* [Examples Overview](examples_overview-md) - An overview of the available code examples | ||
* [Building](building.md) - Instructions for how to build Autobahn|JS from source | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.