5.Collaborative Development

Overview

This tutorial will show you how to define and publish your components, objects, interfaces or plug-in using the NERvHub repository.

First of All...

You have to become a member of the NERvDN developer team. Please open a new issue for the NERvHub with title:

[QUEST]Join NERvHub (YOUR_USERNAME_HERE)

e.g.

[QUEST]Join NERvHub (GPBeta)

Note that the USERNAME should also be your name space and folder name using in NERvHub.

You can also write down your joining purposes to the comment, we will send you the invitation and grant write permission to you on the NERvHub repository as soon as possible.

After that you can get full access to the NERvHub repository, you are now able to create files or edit others' files, so please be careful and polite if you want to modify others' documents. If there's a big problem or when you get confused, just open an issue and invite people to talk together.

It is recommended to clone the NERvHub repository directly inside NERvSDK\include folder, so that you have no need to add path to NERvHub in your projects or the Doxygen configuration file.

Before Commit...

Please test your documents with Doxygen before you can commit the files:

1. Get Doxygen binary distribution for Windows.
2. Pull (or clone) latest NERvSDK repository.
3. Run Doxygen\bin\doxywizard.exe and then open NERvSDK\docs\doxygen\NERvLibrary config file.
4. Change Wizard-Project-Destination Directory to your output folder.
5. (Optional) If you clone NERvHub to somewhere other than NERvSDK\include, remember to add it to Expert-Input-INPUT tag.
6. Click Run-Run Doxygen button to generate the documents.
7. Click Run-Show HTML output button to see the result.

Also, don't forget to pull the latest NERvHub repository every time you commit changes.

I would like to...

Here we go, and this is the map:

• Define and publish components
• Implement and publish component objects
• Define and publish interfaces
• Publish and document your plug-ins