search

online-bridge-hackathon / DDS

An api that returns DDS results for a given deal or partial deal
https://bit.ly/bridge-hackathon
Apache License 2.0
4 stars 6 forks source link

Update docs to automated libdds build #63

Closed suokko closed 4 years ago

suokko commented 4 years ago

doc(README): Improve C++ library build documentation

Add build and test instructions for C++ library. These commands are based on build process initiated by Makefile.

doc(README): Improve dependency installation

Dependencies should be held in one place. The requirements.txt offers a natural place to maintain all requirements which can be installed using a pip command.

doc(README.gcp): Remove C++ library instructions

The C++ library instructions became outdated with changes to automate submodule build. The automation takes care of C++ library build process which allows the cloud build skip directly to the python part of instructions.

There is a small addition to use libdds-build target before trying local server. This makes sure automate C++ library build process will be done before attempting to use the library.

tameware commented 4 years ago

Thanks! I'll look in a couple of hours.

We should add a make target to start the local server. Then libdds can be a prerequisite, as it is for the test target.