From eac09e73142008f48121995861c0d7798001431f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=C5=9B?= Date: Wed, 22 Jan 2025 17:35:25 +0100 Subject: [PATCH] Replace docs index.md with README.md (#2694) --- .github/workflows/docs.yml | 3 +++ docs/index.md | 54 +------------------------------------- 2 files changed, 4 insertions(+), 53 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a1ebf5db5..de3b1a772 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,6 +19,9 @@ jobs: - name: Install dependencies run: poetry install --with docs + - name: Copy README.md to docs/index.md + run: cp README.md docs/index.md + - name: Build site run: | source .venv/bin/activate diff --git a/docs/index.md b/docs/index.md index 8f10a8452..3ae003be4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,53 +1 @@ - -![pwndbg](assets/logo.png) - -`pwndbg` (/poʊndbæg/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers. - -It has a boatload of features, see [FEATURES.md](https://github.com/pwndbg/pwndbg/blob/dev/FEATURES.md) or these docs. - -## Why? - -Vanilla GDB is terrible to use for reverse engineering and exploit development. Typing `x/g30x $esp` is not fun, and does not confer much information. The year is 2020 and GDB still lacks a hexdump command! GDB's syntax is arcane and difficult to approach. Windbg users are completely lost when they occasionally need to bump into GDB. - -## What? - -Pwndbg is a Python module which is loaded directly into GDB, and provides a suite of utilities and crutches to hack around all of the cruft that is GDB and smooth out the rough edges. - -Many other projects from the past (e.g., [gdbinit][gdbinit], [PEDA][PEDA]) and present (e.g. [GEF][GEF]) exist to fill some these gaps. Each provides an excellent experience and great features -- but they're difficult to extend (some are unmaintained, and all are a single [100KB][gdbinit2], [200KB][peda.py], or [300KB][gef.py] file (respectively)). - -Pwndbg exists not only to replace all of its predecessors, but also to have a clean implementation that runs quickly and is resilient against all the weird corner cases that come up. - -[gdbinit]: https://github.com/gdbinit/Gdbinit -[gdbinit2]: https://github.com/gdbinit/Gdbinit/blob/master/gdbinit - -[PEDA]: https://github.com/longld/peda -[peda.py]: https://github.com/longld/peda/blob/master/peda.py - -[GEF]: https://github.com/hugsy/gef -[gef.py]: https://github.com/hugsy/gef/blob/master/gef.py - -## How? - -Installation is straightforward. Pwndbg is best supported on Ubuntu 22.04 or 24.04 and GDB >= 12.1. - -```shell -git clone https://github.com/pwndbg/pwndbg -cd pwndbg -./setup.sh -``` - -If you use any other Linux distribution, we recommend using the latest available GDB built from source. Be sure to pass `--with-python=/path/to/python` to `configure`. - -## What can I do with that? - -For further info about features/functionalities, see [FEATURES](https://github.com/pwndbg/pwndbg/blob/dev/FEATURES.md). - -## Who? - -Pwndbg is an open-source project, written and maintained by [many contributors](https://github.com/pwndbg/pwndbg/graphs/contributors)! - -Want to help with development? Read [CONTRIBUTING](https://github.com/pwndbg/pwndbg/blob/dev/.github/CONTRIBUTING.md). - -## Contact -If you have any questions not worthy of a [bug report](https://github.com/pwndbg/pwndbg/issues), feel free to ping -anybody on [Discord](https://discord.gg/x47DssnGwm) and ask away. +[//]: <> (This file content is replaced by the README.md as part of the workflow.) \ No newline at end of file