Notes

‍These documents are a work in progress, and we are trying to improve upon them on a daily basis. However, given our capacity and workload, there are bound to be things which get missed or checked in which should not have been checked in. If you find mistakes or documents wanting information, and you would like to help, you can do so in two ways

1. Submit corrections. When you update anything and submit a PR, we will review it and if all looks good, it will be added. This is the fastest way that one can expect changes to be in.
2. Submit tickets. If you are not sure how to make updates, or if you are short on time, please raise an issue in the repo, with details and what you think needs to be the expected text. We will try and update the literature to reflect any changes that we feel are merited. Note that this route will take longer than the first approach and there are no guarantees on the timeline.

Examples Repository

We currently maintain a Corelink example repository which contains examples for multiple different clients and plugins.

The C++ example directory contains example projects which demonstrates Corelink's basic functionality, as well as a common way to setup Corelink projects on Windows, OSX, and CLI. The files are commented to help understand the functionality.

For more detailed understanding of how the Corelink client works, have a look at key concepts.

We encourage anyone who has experience with a specific use case of Corelink to contribute a small example project to help other users learn quicker.