Skip to content

Commit 58affb3

Browse files
committed
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
1 parent 6bac1a8 commit 58affb3

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

DevGuide.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Developer's Guide
22

3+
## References
4+
5+
- [Catalog of Dependencies](#catalog-of-dependencies)
6+
- [Install Development and Build Tools](#install-development-and-build-tools)
7+
- [Setup Source Repository](#setup-source-repository)
8+
- [Setup Build Dependency Repository](#setup-build-dependency-repository)
9+
* [Automatic script instructions](#automatic-script-instructions)
10+
* [Manual download instructions](#manual-download-instructions)
11+
- [Building Ghidra](#building-ghidra)
12+
- [Developing Ghidra](#developing-ghidra)
13+
* [Prepare the Environment](#prepare-the-environment)
14+
* [Import Eclipse Projects](#import-eclipse-projects)
15+
* [Building the natives](#building-the-natives)
16+
* [Pre-compile Language Modules](#pre-compile-language-modules-optional)
17+
* [Import and Build GhidraDev project](#import-and-build-ghidradev-project-optional)
18+
* [Run and Debug Ghidra from Eclipse](#run-and-debug-ghidra-from-eclipse)
19+
* [Running tests](#running-tests)
20+
- [Setup build in CI](#setup-build-in-ci)
21+
- [Building Supporting Data](#building-supporting-data)
22+
* [Building Data Type Archives](#building-data-type-archives)
23+
* [Building FID Databases](#building-fid-databases)
24+
325
## Catalog of Dependencies
426

527
The following is a list of dependencies, in no particular order.
@@ -299,7 +321,7 @@ and under _Target Platform_, activate _/Eclipse GhidraDevPlugin/GhidraDev.target
299321
See `~/git/ghidra/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txt`
300322
for instructions on how to build the GhidraDev plugin.
301323

302-
### Run/Debug Ghidra from Eclipse
324+
### Run and Debug Ghidra from Eclipse
303325

304326
To run or debug Ghidra from Eclipse, use the provided launch configuration (usually under the "Run" or "Debug" buttons).
305327
If the launcher does not appear, it probably has not been marked as a favorite.

0 commit comments

Comments
 (0)