gdax-orderbook-hpp/demo/dependencies/websocketpp-0.7.0/docs/getting_started.dox

   1 /** \page getting_started Getting Started
   2
   3 WebSocket++ code is available on github at https://github.com/zaphoyd/websocketpp
   4 The official project homepage lives at http://www.zaphoyd.com/websocketpp
   5
   6 The git repository is organized into several directories:
   7
   8 - **docs**: This documentation
   9 - **examples**: Example programs that demonstrate how to build basic versions of some commonly used patterns for WebSocket clients and servers.
  10 - **test**: Unit tests that confirm that the code you have works properly and help detect platform specific issues.
  11 - **tutorials**: Detailed walkthroughs of a select set of the example programs.
  12 - **websocketpp**: All of the library code and default configuration files.
  13
  14 WebSocket++ is a header only library. You can start using it by including the websocketpp source directory in your project's include path and including the appropriate WebSocket++ headers in your program. You may also need to include and/or link to appropriate Boost/system libraries. TODO: More information: Building a program with WebSocket++, Walkthroughs of the example programs
  15
  16 WebSocket++ includes cmake and scons scripts for building the examples and unit tests. Neither system is needed unless you want to build tests or examples in an automated fashion.
  17
  18 __Usage questions__ should be posted to the project mailing list at http://groups.google.com/group/websocketpp/ or the IRC channel (\#websocketpp on freenode).
  19
  20 __Bugs and issues__ should be posted to the project GitHub issues queue: https://github.com/zaphoyd/websocketpp/issues.
  21
  22 __Pull requests__ on GitHub are welcome. Please make them against the `develop` branch.
  23
  24 WebSocket++ is written and maintained by Peter Thorson. You can contact me via GitHub messaging, IRC, or via email at websocket@zaphoyd.com.
  25
  26 */
  27