Skip to content

Commit 68b1f3e

Browse files
committed
Updated README.md
Fixed the layout oof the text so that it would all be in the same view when rendered in GitHub. Also moved the image up to the top so that its easy to see for those coming to look at the program instead of seeing it after the setup is completed. (This is why devs don't write documentation just read the code.. its the same thing but better)
1 parent c81a5f0 commit 68b1f3e

File tree

2 files changed

+23
-18
lines changed

2 files changed

+23
-18
lines changed

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
2-
</br>
3-
41
# Overview
52
```
6-
This is a quick setup script to aid in installing/configuring important tools for vulnerability research and exploitation.
3+
This is a quick setup script to aid in installing/configuring important tools for
4+
vulnerability research and exploitation.
75
8-
I built this since I ssh into my homelab to use these tools (I hate GUIs) and I wanted to have a quick setup script to get everything installed and configured in the case I need to rebuild my environment.
6+
I built this since I ssh into my homelab to use these tools (I hate GUIs) and I wanted
7+
to have a quick setup script to get everything installed and configured in the case
8+
I need to rebuild my environment.
99
```
1010
</br>
1111

12+
# Layout For PWBDBG
13+
<a href="https://github.com/abaker2010/gdb-quick-setup">
14+
<img src="./images/running_image.png" alt="gdb-quick-setup">
15+
</a>
16+
17+
</br>
18+
1219
# Tools Installed
1320
```
1421
- gdb
@@ -20,6 +27,8 @@ I built this since I ssh into my homelab to use these tools (I hate GUIs) and I
2027
- tmux
2128
- r2ghidra
2229
- radare2
30+
- vim
31+
- neovim
2332
```
2433

2534
</br>
@@ -46,7 +55,8 @@ chmod +x setup.sh
4655

4756
# Coffee Break ☕
4857
```
49-
This will take a while to get everything installed and configured. A few of the tools are built from source, this helps to ensure compatibility with each system this is used on.
58+
This will take a while to get everything installed and configured. A few of the tools are
59+
built from source, this helps to ensure compatibility with each system this is used on.
5060
5161
Should take about 10-15 minutes to complete.
5262
```
@@ -58,7 +68,9 @@ Should take about 10-15 minutes to complete.
5868
Preparing Terminal
5969
------------------
6070
61-
Due to some of add-ons that were installed to work with splitting the terminal, you will need to use the following TMUX command before running PWNDBG. This will create a new tmux session called "pwndbg_session" and then you can run gdb with pwndbg.
71+
Due to some of add-ons that were installed to work with splitting the terminal, you will
72+
need to use the following TMUX command before running PWNDBG. This will create a new
73+
tmux session called "pwndbg_session" and then you can run gdb with pwndbg.
6274
6375
Command
6476
-------
@@ -69,17 +81,10 @@ Due to some of add-ons that were installed to work with splitting the terminal,
6981
Running PWNDBG
7082
--------------
7183
72-
To run pwndbg, its pretty much the same command as plain GDB simply run the following command:
84+
To run pwndbg run the following command:
7385
7486
Command
7587
-------
76-
pwndbg <binary>
77-
```
78-
79-
</br>
80-
81-
# PWNDBG Example
8288
83-
<a href="https://github.com/abaker2010/gdb-quick-setup">
84-
<img src="./images/running_image.png" alt="gdb-quick-setup">
85-
</a>
89+
gdb-pwndbg <binary>
90+
```

setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
2-
#
2+
# Aaorn Baker
33
## Color codes
44
RED='\033[0;31m'
55
GREEN='\033[0;32m'

0 commit comments

Comments
 (0)