GP-4978: Converting GhidraDev README to markdown

DevGuide.md

@@ -122,7 +122,7 @@ Import the newly generated GhidraDev projects into an Eclipse that supports this
 __Note:__ If you are getting compilation errors related to PyDev and CDT, go into Eclipse's 
 preferences, and under _Target Platform_, activate _/Eclipse GhidraDevPlugin/GhidraDev.target_.
 
-See [GhidraDevPlugin/build_README.txt](GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txt)
+See [Building GhidraDev](GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/README.md#building)
 for instructions on how to build the GhidraDev plugin.
 
 ## Running tests

GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build.gradle

@@ -4,9 +4,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -122,8 +122,9 @@ rootProject.assembleDistribution {
 		include 'GhidraDev*.zip'
 		into "Extensions/Eclipse/GhidraDev/"
 	}
-	from ("${this.projectDir}/GhidraDev_README.html") {
+	from ("${this.projectDir}/README.md") {
 		into "Extensions/Eclipse/GhidraDev/"
+		rename 'README.md', 'GhidraDev_README.md'
 	}
 } 
 

GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txt

@@ -1,39 +0,0 @@
-GhidraDev is currently built from Eclipse and checked into the bin repo.  Ideally we will use Gradle
-one day, but we aren't there yet.  We do rely on Gradle prepDev to generate the Eclipse project and 
-build GhidraDev's dependencies though, hence the build.gradle file.
-
-NOTE: Only "Eclipse for RCP and RAP Developers" has the ability to do the below instructions.  The
-following instructions assume that you are using this version of Eclipse.
-
-Importing GhidraDev Eclipse projects (they are deactivated by default):
-  1) Run gradle eclipse -PeclipsePDE
-  2) From Eclipse, File --> Import --> General --> Existing Projects into Workspace
-  3) From the ghidra repo, import "Eclipse GhidraDevFeature" and "Eclipse GhidraDevPlugin".
-
-Changing version number (GhidraDev is versioned independently of Ghidra):
-  1) Open plugin.xml in the GhidraDevPlugin project.
-  2) In the "Overview" tab, update the "Version" field to x.y.z.qualifier and save.
-  3) Open feature.xml in the GhidraDevFeature project.
-  4) In the "Overview" tab, update the "Version" field to x.y.z.qualifier and save.
-  5) Open category.xml in the GhidraDevFeature project.
-  6) Highlight ghidra.ghidradev (x.y.z.qualifier), and click "Remove".
-  7) Highlight ghidra.ghidradev, and click "Add Feature".
-  8) Select ghidra.ghidradev (x.y.z.qualifer), click "OK", and save.
-  9) Update GhidraDev_README.html "Change History" section if necessary.
-
-Building from Eclipse:
-  1) Do a Gradle prepDev to ensure GhidraDev's dependencies are up-to-date.
-  2) File --> Export --> Plug-in Development --> Deployable features
-  3) Check ghidra.ghidradev (x.y.z.qualifier)
-  4) Select "Archive file" and choose a directory to save it to.  It must end up in
-     ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/.  Name it GhidraDev-x.y.z.zip.
-  5) In the "Options" tab make sure things look like this:
-     - Export source: UNCHECKED
-     - Package as individual JAR archives: CHECKED
-     - Generate p2 repository: CHECKED
-     - Categorize repository: CHECKED + Browse to category.xml file in the GhidraDevFeature project.
-     - Qualifier replacement: CHECKED + clear field so default is used
-     - Save as Ant script: UNCHECKED
-     - Allow for binary cycles in target platform: CHECKED
-     - Use class files compiled in the workspace: UNCHECKED
-  6) Finish

GhidraBuild/EclipsePlugins/GhidraDev/certification.manifest

@@ -7,8 +7,8 @@ GhidraDevPlugin/.launch/GhidraDev.launch||GHIDRA||||END|
 GhidraDevPlugin/GhidraDev.target||GHIDRA||||END|
 GhidraDevPlugin/GhidraDev_README.html||GHIDRA||||END|
 GhidraDevPlugin/META-INF/MANIFEST.MF||GHIDRA||||END|
+GhidraDevPlugin/README.md||GHIDRA||||END|
 GhidraDevPlugin/build.properties||GHIDRA||||END|
-GhidraDevPlugin/build_README.txt||GHIDRA||||END|
 GhidraDevPlugin/icons/GhidraIcon16.png||GHIDRA||||END|
 GhidraDevPlugin/icons/GhidraIcon16_bw.png||GHIDRA||||END|
 GhidraDevPlugin/icons/brick_add.png||FAMFAMFAM Icons - CC 2.5|||famfamfam silk icon set|END|

GhidraDocs/InstallationGuide.html

@@ -486,7 +486,7 @@ can be found in the <i>&lt;GhidraInstallDir&gt;</i>/Extensions directory.</p>
   <li>
     <b>Eclipse: </b>The GhidraDev Eclipse plugin for a pre-existing Eclipse installation. For
     information on installing and using the GhidraDev Eclipse plugin, see
-    <i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.html.
+    <i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.md.
   </li>
   <li>
     <b>Ghidra: </b>Ghidra extensions (formerly known as contribs). See
@@ -544,7 +544,7 @@ plugins, analyzers, etc.</p>
 <p>Ghidra supports development in Eclipse by providing a custom Eclipse plugin called
 <b>GhidraDev</b>, which can be found in the <i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse
 directory. For more information on installing and using the GhidraDev Eclipse plugin, see
-<i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.html.</p>
+<i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.md.</p>
 <p><b>NOTE: </b>Eclipse is not provided with Ghidra.  The GhidraDev Eclipse plugin is designed to
 be installed in a pre-existing Eclipse installation.</p>
 <p>Ghidra scripting API javadocs can be found at 
@@ -718,7 +718,7 @@ be installed in a pre-existing Eclipse installation.</p>
     Building new Ghidra module extensions on macOS (OS X) using a network drive (including a
     network-mapped home directory) throws a Java exception.  This issue is known to the Java/macOS
     community but a fix has not yet been released.  See
-    <i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.html for more
+    <i>&lt;GhidraInstallDir&gt;</i>/Extensions/Eclipse/GhidraDev/GhidraDev_README.md for more
     information on building Ghidra module extensions from Eclipse.
   </li>
 </ul>

README.md

@@ -137,4 +137,4 @@ source project.
 [eclipse]: https://www.eclipse.org/downloads/packages/
 [master]: https://github.com/NationalSecurityAgency/ghidra/archive/refs/heads/master.zip
 [security]: https://github.com/NationalSecurityAgency/ghidra/security/advisories
-[ghidradev]: https://htmlpreview.github.io/?https://github.com/NationalSecurityAgency/ghidra/blob/master/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/GhidraDev_README.html
+[ghidradev]: GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/README.md