Skip to content

Commit f54438b

Browse files
committed
README: Update example path for Flathub package
The existing path didn't work for me.
1 parent 7977b81 commit f54438b

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,11 @@ $ ./gradlew
4747
echo GHIDRA_INSTALL_DIR=/path/to/ghidra > gradle.properties
4848
```
4949

50-
> Note: if you are using the flatpak version of ghidra, the path to ghidra is available at `/var/lib/flatpak/app/org.ghidra_sre.Ghidra/current/active/files/lib/`
50+
> [!NOTE]
51+
> `GHIDRA_INSTALL_DIR` should point to the directory which contains
52+
> `support/buildExtension.gradle`. For example, users of the
53+
> [Flathub package][3] should use
54+
> `/var/lib/flatpak/app/org.ghidra_sre.Ghidra/current/active/files/lib/ghidra`.
5155
5256
The module ZIP will be output to `dist/`. Use **File > Install Extensions** and
5357
select the green plus to browse to the extension. Restart Ghidra when prompted.
@@ -98,9 +102,9 @@ in `data` and rebuild the plugin.
98102

99103
### Related projects
100104
These are some interesting projects related to UEFI reversing:
101-
- [efiXplorer][3] - IDA plugin for UEFI firmware analysis and reverse
105+
- [efiXplorer][4] - IDA plugin for UEFI firmware analysis and reverse
102106
engineering automation
103-
- [Ghidra-EFI-Byte-Code-Processor][4] - EFI Byte Code (EBC) processor module
107+
- [Ghidra-EFI-Byte-Code-Processor][5] - EFI Byte Code (EBC) processor module
104108
for Ghidra
105109

106110
## License
@@ -109,10 +113,8 @@ Apache 2.0, with some exceptions:
109113

110114
## Credits
111115
`src/efidecompress/c/efidecompress.c` is a lightly modified version of
112-
[Decompress.c][5] from uefi-firmware-parser (which itself is derived from
113-
[the original in EDK2 BaseTools][6]).
114-
115-
`lib/xz-1.8.jar` is taken from the [XZ for Java][7] project.
116+
[Decompress.c][6] from uefi-firmware-parser (which itself is derived from
117+
[the original in EDK2 BaseTools][7]).
116118

117119
The IFD FS loader in `src/main/java/firmware/ifd` used the parser from
118120
[UEFITool][8] as a reference.
@@ -129,11 +131,11 @@ UEFI helper script.
129131

130132
[1]: https://ghidra-sre.org/
131133
[2]: https://summerofcode.withgoogle.com/projects/#6413737605464064
132-
[3]: https://github.com/binarly-io/efiXplorer
133-
[4]: https://github.com/meromwolff/Ghidra-EFI-Byte-Code-Processor
134-
[5]: https://github.com/theopolis/uefi-firmware-parser/blob/21106baf019db9dcd046a3c01ee7b32212de45a5/uefi_firmware/compression/Tiano/Decompress.c
135-
[6]: https://github.com/tianocore/edk2/blob/2e351cbe8e190271b3716284fc1076551d005472/BaseTools/Source/C/Common/Decompress.c
136-
[7]: https://tukaani.org/xz/java.html
134+
[3]: https://flathub.org/en/apps/org.ghidra_sre.Ghidra
135+
[4]: https://github.com/binarly-io/efiXplorer
136+
[5]: https://github.com/meromwolff/Ghidra-EFI-Byte-Code-Processor
137+
[6]: https://github.com/theopolis/uefi-firmware-parser/blob/21106baf019db9dcd046a3c01ee7b32212de45a5/uefi_firmware/compression/Tiano/Decompress.c
138+
[7]: https://github.com/tianocore/edk2/blob/2e351cbe8e190271b3716284fc1076551d005472/BaseTools/Source/C/Common/Decompress.c
137139
[8]: https://github.com/LongSoft/UEFITool
138140
[9]: https://github.com/LongSoft/UEFITool/blob/f863caac9df1c5258e9bcc0441a695b6a3bbaf7c/common/guids.csv
139141
[10]: https://github.com/NationalSecurityAgency/ghidra/pull/501#issuecomment-498374810

0 commit comments

Comments
 (0)