diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28fc51cd45..5323724a9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,9 +129,9 @@ For the basic code styling complex uses `clang-format`, the formatting file is i - Be sure to include the following at the bottom of all documentation files ```markdown -## DREAM3DNX Help ## +## DREAM3D-NX Help ## -Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers. +If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. ``` ## Community diff --git a/PortingFilters.md b/PortingFilters.md index b078c05604..7f2a2b267b 100644 --- a/PortingFilters.md +++ b/PortingFilters.md @@ -1,4 +1,4 @@ -# Porting a Filter # +# Porting a Filter Depending on where the ported filter is coming from determines what you need to do. The sections are as follows: @@ -13,17 +13,17 @@ do. The sections are as follows: -## SECTION 1 : Porting From ***SIMPL*** to ***Filters Folder*** ## +## SECTION 1 : Porting From ***SIMPL*** to ***Filters Folder*** This will be the most common type of Filter porting. The steps for this are as follows: -### Go to FreeNas and pull the custom build of DREAM3D ### +### Go to FreeNas and pull the custom build of DREAM3D This custom build has **ALL** ***SIMPL*** plugins compiled so you don't need to worry about what filters will be available -### Load up ***SIMPL*** DREAM3D and navigate to ***ComplexFilterGen*** ### +### Load up ***SIMPL*** DREAM3D and navigate to ***ComplexFilterGen*** Here you will need to set the command arguments using the following syntax: @@ -40,14 +40,14 @@ Some nuances to note for this are as follows: You will need to update the various CMake files inside the target complex plugin in order to start compiling the new filter code inside of a complex build. -## SECTION 2 : Porting stubs from existing folder to ***Filters Folder*** ## +## SECTION 2 : Porting stubs from existing folder to ***Filters Folder*** Some plugins have existing stubs in folders other than the primary ***Filters*** folder. -### Move the Filter and Algorithm files to the active ***Filters Folder*** ### +### Move the Filter and Algorithm files to the active ***Filters Folder*** -### Update the Legacy UUID Maps ### +### Update the Legacy UUID Maps
  1. Open the LegacyUUIDMapping header file for this Plugin
  2. Find and uncomment the include statement for the filter being moved
  3. @@ -63,12 +63,12 @@ folder. > ***@@__MAP__UPDATE__TOKEN__DO__NOT__DELETE__@@*** - ### Update the CMakeLists.txt files to reflect the changes ### + ### Update the CMakeLists.txt files to reflect the changes This includes the ones for the unit tests and the one at the plugin level -## SECTION 3 : Developing a Test File ## +## SECTION 3 : Developing a Test File Firstly, it is important to ensure that each unit test does not just instantiate filter. Current standards require the following: