Skip to content

Commit

Permalink
Minor additions to the documentation (#975)
Browse files Browse the repository at this point in the history
* added more references to gef-extras

* adding a note about required common bins (issue #973)

* applied `markdownlint`

* manual markdownl formatting
  • Loading branch information
hugsy authored Aug 1, 2023
1 parent 27a29d9 commit b57e174
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ d more comprehensible layout to GDB Python API.
* Built around an architecture abstraction layer, so all commands work in any GDB-supported
architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
* Suited for real-life apps debugging, exploit development, just as much as CTF
* And a lot more commands contributed by the community available on
[GEF-Extras](https://github.com/hugsy/gef-extras) !!

Check out the [Screenshot page](docs/screenshots.md) for more or [try it
online](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ It requires Python 3, but [`gef-legacy`](https://github.com/hugsy/gef-legacy) ca
* Built around an architecture abstraction layer, so all commands work in any GDB-supported
architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
* Suited for real-life debugging, exploit development, just as much as for CTFs
* And a lot more commands contributed by the community available on [GEF-Extras](https://github.com/hugsy/gef-extras) !!

Check out the [showroom page](https://hugsy.github.io/gef/screenshots/) for more | or [try it online
yourself!](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
Expand Down
8 changes: 8 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## Prerequisites

Specific GEF commands rely on commonly used Unix commands to extract additional information. Therefore it requires the following binaries to be present:
* `file`
* `readelf`
* `ps`
* `python3`

Those tools are included by default in many modern distributions. If they're missing, you can use your OS package manager to install them.

### GDB

Only [GDB 8 and higher](https://www.gnu.org/s/gdb) is required. It must be compiled with Python 3.6
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ theme:

nav:
- Home: index.md
- Coverage: https://hugsy.github.io/gef/coverage/
- Showroom: screenshots.md
- Setup:
- Installation: install.md
Expand All @@ -22,6 +21,7 @@ nav:
- Testing: testing.md
- Write extensions: api.md
- API: api/gef.md
- Coverage: https://hugsy.github.io/gef/coverage/
- Commands:
- aliases: commands/aliases.md
- aslr: commands/aslr.md
Expand Down Expand Up @@ -76,4 +76,5 @@ nav:
- got: functions/got.md
- heap: functions/heap.md
- stack: functions/stack.md
- GEF-Extras: https://hugsy.github.io/gef-extras/
- Deprecated: deprecated.md

0 comments on commit b57e174

Please sign in to comment.