Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DennyDai committed Mar 10, 2024
1 parent 276c11a commit 27acd93
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
)](https://github.com/purseclab/Patcherex2/actions/workflows/test.yml)
[![License](https://img.shields.io/github/license/purseclab/patcherex2.svg)](https://github.com/purseclab/Patcherex2/blob/main/LICENSE)

> [!WARNING]
> This project is currently in its initial development stages. Please anticipate potential breaking changes. The first stable release is targeted for early March 2024.
Patcherex2 is a rewritten adaptation of the original [Patcherex](https://github.com/angr/patcherex) project, aimed at building upon its core ideas and extending its capabilities.

## Installation
Expand Down Expand Up @@ -110,8 +107,6 @@ The core of Patcherex2 consists of 9 different types of patches, which are used
| _**Remove**_ | RemoveDataPatch | RemoveInstructionPatch | RemoveFunctionPatch |
| _**Modify**_ | ModifyDataPatch | ModifyInstructionPatch | ModifyFunctionPatch |

In this modification, I've placed the colon on the right side of the dashes in the separator row beneath

These patches are categorized into three tiers:
- Data Patches:
Operating at the raw bytes level, data patches are ideal for patching the `.data` section or any other raw data.
Expand Down Expand Up @@ -171,12 +166,12 @@ Each tier features three patch types:
#### Referencing previously inserted content.
Examples:
- This will load effective address of the data `my_data` into the `rsi` register.
```
```python
InsertDataPatch("my_data", b"Hello, World!")
InsertInstructionPatch(0xdeadbeef, "lea rsi, [{my_data}]")
```
- This will replace the content of function `foo` to call function `bar` and return the result.
```
```python
InsertFunctionPatch("bar", "int bar() { return 42; }")
ModifyFunctionPatch("foo", "int bar(void); int foo() { return bar(); }")
```
Expand Down

0 comments on commit 27acd93

Please sign in to comment.