Git Submodule

Adding to your project

1. Open a terminal at the root of a local repo and type:
   git submodule add https://github.com/rappen/Rappen.XTB.Helper
2. Right click your solution in Visual Studio, select Add Existing Project (twice), and include the projects from the cloned submodule:
     Rappen.XRM.Helpers.shproj (requires for the belows)
     Rappen.XRM.Tokens.shproj (if using XRM Tokens and/or Power Fx)
     Rappen.XTB.Helper.shproj (if creating XrmToolBox tools)
3. In your project, add a References to the both added shared project Rappen.XRM.Helpers and might add Rappen.XRM.Tokens and maybe Rappen.XTB.Helpers.
4. Compile the project once, to make sure everything works and to make it possible for Visual Studio to find the controls in the tool window.
5. If you added Rappen.XTB.Helpers, open a WinForm designer and the Tool window, and all the controls listed below should be available under a group with the name of your project.
6. Helper and extension classes can now be used and examined within the added project.

Sometimes, the submodules are not of right version of no files local, try this from the Rappen.XTB.Helpers folder:
git submodule update --force

 

Updating your project with latest

1. Open a terminal at the root of the helper submodule. This is probably
   [your project folder]\Rappen.XTB.Helpers.
2. Type:
   git pull
   or
   git pull https://github.com/rappen/Rappen.XTB.Helper main

Yes, there may be slightly breaking changes, but that's life on the cutting edge.

Majorly breaking changes will be announced in this readme.

 

Remove

If you ever want to remove the submodule - read this gits or this on StackOverflow.