update readme (#3010)

README.md

@@ -2,7 +2,7 @@
 # pwndbg
 
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://choosealicense.com/licenses/mit/)
-[![Unit tests](https://github.com/pwndbg/pwndbg/actions/workflows/tests.yml/badge.svg?branch=dev&event=push)](https://github.com/pwndbg/pwndbg/actions/workflows/tests.yml)
+[![Tests](https://github.com/pwndbg/pwndbg/actions/workflows/tests.yml/badge.svg?branch=dev&event=push)](https://github.com/pwndbg/pwndbg/actions/workflows/tests.yml)
 [![codecov.io](https://codecov.io/github/pwndbg/pwndbg/branch/dev/badge.svg?token=i1cBPFVCav)](https://app.codecov.io/github/pwndbg/pwndbg/tree/dev)
 [![Discord](https://img.shields.io/discord/843809097920413717?label=Discord&style=plastic)](https://discord.gg/x47DssnGwm)
 
@@ -10,34 +10,38 @@
 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) and [CHEATSHEET][CHEATSHEET]
+It has a boatload of features, see [FEATURES.md](https://github.com/pwndbg/pwndbg/blob/dev/FEATURES.md)
-(feel free to print it!).
+and [CHEATSHEET][CHEATSHEET] (feel free to print it!). If you have any questions you may read the
+[documentation](https://pwndbg.re/pwndbg/latest/) or asks us in our [Discord server](https://discord.gg/x47DssnGwm).
 
 [CHEATSHEET]: https://drive.google.com/file/d/16t9MV8KTFXK7oX_CzXhmDdaVnjT8IYM4/view?usp=drive_link
 
 ## Why?
 
 Vanilla GDB and LLDB are terrible to use for reverse engineering and exploit development.
-Typing `x/g30x $esp` or navigating cumbersome LLDB commands is not fun and often provides
+Typing `x/30gx $rsp` or navigating cumbersome LLDB commands is not fun and often provides
 minimal information. The year is 2025, and core debuggers still lack many user-friendly
 features such as a robust hexdump command. Windbg users are completely lost when they
 occasionally need to bump into GDB or LLDB.
 
-## What?
+Pwndbg is a Python module which is loaded directly into GDB or LLDB. It provides a suite
-
-Pwndbg is a Python module which is loaded directly into GDB or LLDB*. It provides a suite
 of utilities and enhancements that fill the gaps left by these debuggers, smoothing out
 rough edges and making them more user-friendly.
 
+## Installation
+
+See [installation instructions](https://pwndbg.re/pwndbg/latest/setup).
+
+## What about ...?
+
 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
+(e.g. [GEF][GEF]) exist to fill some of 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 [363KB][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.  It also comes batteries-included, so all of its features are available
+that come up.
-if you run `setup.sh`.
 
 [gdbinit]: https://github.com/gdbinit/Gdbinit
 [gdbinit2]: https://github.com/gdbinit/Gdbinit/blob/master/gdbinit
@@ -62,10 +66,10 @@ Here's a quick guide to help you decide which one to use:
 | Embedded debugging (ARM Cortex M* or RISC-V/32) | **GDB**, **LLDB**    |
 
 Pwndbg ensures a consistent experience across both, so switching between them is seamless.
-> The LLDB implementation in Pwndbg is still in early-stage and may contain bugs or limitations.<br/>
+> The LLDB implementation in pwndbg is still in early-stage and may contain bugs or limitations.<br/>
 > Known issues are tracked in [GitHub Issues][lldb_tracker].
 >
-> If you encounter any problems, feel free to report them or discuss on our [Discord server][discord].
+> If you encounter any problems, feel free to report them or discuss on our [Discord server](https://discord.gg/x47DssnGwm).
 
 [lldb_tracker]: https://github.com/pwndbg/pwndbg/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22LLDB%20Port%22
 
@@ -77,31 +81,9 @@ Pwndbg ensures a consistent experience across both, so switching between them is
 | qemu-user   | QEMU 8.1+                       | vFile API is needed for vmmap        |
 | qemu-system | QEMU 6.2+                       | Supported version since ubuntu 22.04 |
 
-## How?
-
-See [installation instructions](https://pwndbg.re/pwndbg/dev/setup).
-
-## 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, maintained by [many contributors](https://github.com/pwndbg/pwndbg/graphs/contributors)!
-
-Pwndbg was originally created by [Zach Riggle](https://github.com/zachriggle), who is no longer with us. We want to thank Zach for all of his contributions to Pwndbg and the wider security community.
-
-Want to help with development? Read [CONTRIBUTING](https://github.com/pwndbg/pwndbg/blob/dev/.github/CONTRIBUTING.md) or [join our Discord server][discord]!
-
-## How to develop?
-To run tests locally you can do this in docker image, after cloning repo run simply
-```shell
-docker compose run main ./tests.sh
-```
-Disclaimer - this won't work on apple silicon macs.
 
-## Contact
+## Contributing
-If you have any questions not worthy of a [bug report](https://github.com/pwndbg/pwndbg/issues), feel free to ping
+Pull requests are welcome ❤️. Check out the [Contributing Guide](https://pwndbg.re/pwndbg/dev/contributing/).
-anybody on [Discord][discord] and ask away.
 
-[discord]: https://discord.gg/x47DssnGwm
+## Acknowledgements
+Pwndbg was originally created by [Zach Riggle](https://github.com/zachriggle), who is no longer with us. We want to thank Zach for all of his contributions to pwndbg and the wider security community.