diff --git a/README.md b/README.md index 7985bd718..e8d014228 100644 --- a/README.md +++ b/README.md @@ -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`) diff --git a/docs/index.md b/docs/index.md index f063bd161..6785805e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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`) diff --git a/docs/install.md b/docs/install.md index eac4d8fad..37937b051 100644 --- a/docs/install.md +++ b/docs/install.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 140f56a64..5e209372f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,6 @@ theme: nav: - Home: index.md -- Coverage: https://hugsy.github.io/gef/coverage/ - Showroom: screenshots.md - Setup: - Installation: install.md @@ -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 @@ -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