Skip to content
This repository was archived by the owner on Jan 3, 2024. It is now read-only.

README.md

Latest commit

 

History

History
89 lines (65 loc) · 2.74 KB

README.md

File metadata and controls

89 lines (65 loc) · 2.74 KB

CollabServer - Client Interface

license build-status-master

master dev
build-status-master build-status-master

Overview

End-user interface to connect and work with a running instance of collab-server.

Getting Started

  1. Make sure you have all the requirements
  2. Build this project (see build instructions)
  3. Include the collabdata headers
  4. Include the collabclient headers
  5. Link your application with libcollabclient.a (built in the previous step)

Features

  • Server
    • Connect to a CollabServer
    • Disconnect from a CollabServer
  • Data
    • Start a collaborative room for a data
    • Join a collaborative room for an existing data
    • Leave the current room

Build (CMake)

# Build the tests and examples

mkdir build
cd build
cmake -DCOLLABSERVER_CLIENT_TESTS=ON -DCOLLABSERVER_CLIENT_EXAMPLES=ON ..
make
make runTests
make runExamples

# Or use the build script
./build.sh
CMake option Description
COLLABSERVER_CLIENT_TESTS (ON / OFF) Set ON to build unit tests
COLLABSERVER_CLIENT_EXAMPLES (ON / OFF) Set ON to build examples
CMAKE_BUILD_TYPE Debug, Release, RelWithDebInfo, MinSizeRel

Generate Documentation

  1. Install Doxygen
  2. Run doxygen Doxyfile
  3. Files are placed in doc folder

Contribution

Feel free to ask me any question, share your ideas or open an issue. I started this project during my master thesis at University of Montreal. Format uses clang-format with the Google Coding style https://google.github.io/styleguide/cppguide.html (see .clang-format for further information). Make sure you autoformat on save (see https://clang.llvm.org/docs/ClangFormat.html)