README.md: add portable info

pull/1943/head
psondej 2 years ago committed by Disconnect3d
parent 139b7542cd
commit 8a22162495

@ -31,7 +31,9 @@ Pwndbg exists not only to replace all of its predecessors, but also to have a cl
## How? ## How?
Installation is straightforward: For a portable version with no external dependencies, scroll down for the [Portable Installation](#portable-installation) section.
Installation from source is straightforward:
```shell ```shell
git clone https://github.com/pwndbg/pwndbg git clone https://github.com/pwndbg/pwndbg
@ -39,12 +41,6 @@ cd pwndbg
./setup.sh ./setup.sh
``` ```
Or install via the Nix package manager (you can use Nix on any distribution):
```shell
nix shell github:pwndbg/pwndbg
pwndbg ./your-binary
```
Pwndbg is supported on Ubuntu 20.04, and 22.04 with GDB 9.2 and later. We do not test on any older versions of Ubuntu, so `pwndbg` may not work on these versions (for Ubuntu 18.04 use the [2023.07.17: ubuntu18.04-final release](https://github.com/pwndbg/pwndbg/releases/tag/2023.07.17)). We may accept pull requests fixing issues in older versions on a case by case basis, please discuss this with us on [Discord](https://discord.gg/x47DssnGwm) first. You can also always checkout an older version of `pwndbg` from around the time the Ubuntu version you're interested in was still supported by Canonical, or you can attempt to build a newer version of GDB from source. Pwndbg is supported on Ubuntu 20.04, and 22.04 with GDB 9.2 and later. We do not test on any older versions of Ubuntu, so `pwndbg` may not work on these versions (for Ubuntu 18.04 use the [2023.07.17: ubuntu18.04-final release](https://github.com/pwndbg/pwndbg/releases/tag/2023.07.17)). We may accept pull requests fixing issues in older versions on a case by case basis, please discuss this with us on [Discord](https://discord.gg/x47DssnGwm) first. You can also always checkout an older version of `pwndbg` from around the time the Ubuntu version you're interested in was still supported by Canonical, or you can attempt to build a newer version of GDB from source.
Other Linux distributions are also supported via `setup.sh`, including: Other Linux distributions are also supported via `setup.sh`, including:
@ -66,6 +62,50 @@ cd build
make -j7 make -j7
``` ```
## Portable Installation:
The portable version includes all necessary dependencies and should work without the need to install additional packages.
### Download the Portable Version:
Download the portable version from the [Pwndbg releases page](https://github.com/pwndbg/pwndbg/releases) by selecting the desired version.
Choose the appropriate version for your system architecture (x86_64 or aarch64).
### Installation on RPM-based Systems (CentOS/Alma/Rocky/RHEL):
```shell
dnf install ./pwndbg-2023.07.17.x86_64.rpm
# pwndbg
```
### Installation on DEB-based Systems (Debian/Ubuntu/Kali):
```shell
apt install ./pwndbg_2023.07.17_amd64.deb
# pwndbg
```
### Installation on Alpine:
```shell
apk add --allow-untrusted ./pwndbg_2023.07.17_x86_64.apk
# pwndbg
```
### Installation on Arch Linux:
```shell
pacman -U ./pwndbg-2023.07.17-1-x86_64.pkg.tar.zst
# pwndbg
```
### Generic Linux Installation:
```shell
tar -v -xf ./pwndbg_2023.07.17_amd64.tar.gz
# ./pwndbg/bin/pwndbg
```
## What can I do with that? ## What can I do with that?
For further info about features/functionalities, see [FEATURES](FEATURES.md). For further info about features/functionalities, see [FEATURES](FEATURES.md).
@ -88,3 +128,4 @@ Disclaimer - this won't work on apple silicon macs.
## Contact ## Contact
If you have any questions not worthy of a [bug report](https://github.com/pwndbg/pwndbg/issues), feel free to ping 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. anybody on [Discord](https://discord.gg/x47DssnGwm) and ask away.

Loading…
Cancel
Save