From 58affb3e737e726eb150e088df39ee9477f27029 Mon Sep 17 00:00:00 2001 From: Andrii Kurdiumov Date: Wed, 13 Nov 2019 19:05:38 +0200 Subject: [PATCH] Add Table of Contents for the Dev Guide Main idea is to provide easier overview of the DevGuide, since right now it is somewhat complicated to start hacking. Rename name of the guide to be able create links which work in Eclipse and GitHub at same time --- DevGuide.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/DevGuide.md b/DevGuide.md index a623230624..d46266533d 100644 --- a/DevGuide.md +++ b/DevGuide.md @@ -1,5 +1,27 @@ # Developer's Guide +## References + +- [Catalog of Dependencies](#catalog-of-dependencies) +- [Install Development and Build Tools](#install-development-and-build-tools) +- [Setup Source Repository](#setup-source-repository) +- [Setup Build Dependency Repository](#setup-build-dependency-repository) + * [Automatic script instructions](#automatic-script-instructions) + * [Manual download instructions](#manual-download-instructions) +- [Building Ghidra](#building-ghidra) +- [Developing Ghidra](#developing-ghidra) + * [Prepare the Environment](#prepare-the-environment) + * [Import Eclipse Projects](#import-eclipse-projects) + * [Building the natives](#building-the-natives) + * [Pre-compile Language Modules](#pre-compile-language-modules-optional) + * [Import and Build GhidraDev project](#import-and-build-ghidradev-project-optional) + * [Run and Debug Ghidra from Eclipse](#run-and-debug-ghidra-from-eclipse) + * [Running tests](#running-tests) +- [Setup build in CI](#setup-build-in-ci) +- [Building Supporting Data](#building-supporting-data) + * [Building Data Type Archives](#building-data-type-archives) + * [Building FID Databases](#building-fid-databases) + ## Catalog of Dependencies The following is a list of dependencies, in no particular order. @@ -299,7 +321,7 @@ and under _Target Platform_, activate _/Eclipse GhidraDevPlugin/GhidraDev.target See `~/git/ghidra/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txt` for instructions on how to build the GhidraDev plugin. -### Run/Debug Ghidra from Eclipse +### Run and Debug Ghidra from Eclipse To run or debug Ghidra from Eclipse, use the provided launch configuration (usually under the "Run" or "Debug" buttons). If the launcher does not appear, it probably has not been marked as a favorite.