Skip to content
Snippets Groups Projects
Forked from Corelink / corelink-examples
4 commits behind, 1 commit ahead of the upstream repository.

corelink-examples

Corelink examples, demos

Adding to this Repository

In order to maintain some semblance of organization in the many examples we have there are file/directory naming conventions that should be followed

Adding a Client Example

Client examples are stored in the client-examples subdirectory.

This is an example.

Follow these steps to add an example:

  1. Navigate to the language your example is written in.
  2. Create a new folder with the name of your example and enter into it.
  3. Create new folders with the name of your example followed by receiver or sender. 1
  4. Populate those folders with your examples; with the main file using the same name as the folder that holds it.
  5. Optionally create a debug folder to hold other files.

(1) If this is not applicable, just create folder with the name of the example. Include the README and other documentation in that directory along with another subdirectory that mirrors the name of the example.

Adding a Plugin Examples

Plugin examples are stored in plugin-examples subdirectory.

This is an example.

Follow these steps to add a plugin:

  1. Navigate to the language your plugin is written in.
  2. Create a new folder with the name of your plugin and enter into it.
  3. Populate this folder with your plugin; with the main file using the same name as the folder that holds it.