Skip to content

Commit

Permalink
Update to 0.4.0, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dd86k committed May 23, 2024
1 parent 76d5096 commit ddfa846
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 28 deletions.
29 changes: 2 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Features:
- Disassembler (using Capstone)
- Object server

Written from scratch for educational purposes.
Written from scratch for self-taught educational purposes.

## Warnings

Expand All @@ -23,9 +23,7 @@ None of the functions are currently thread-safe.

# Usage

The application features two modes:
- Debugger
- Image dumper
Usage for `alicedbg` (Debugger) and `alicedump` (Dumper) can be looked in the repo Wiki.

The disassembly feature is provided by Capstone 4.0.2.

Expand All @@ -39,29 +37,6 @@ For other platforms, package names are typically:

Capstone is licensed under the 3-clause BSD license.

## Debugger

The debugger is the default operating mode.

In this mode, the default option is to spawn a process with a file path.

To attach to a live process, use the `--attach PID` option, where PID is a
Process ID.

Examples:
- Spawn process on Windows: `alicedbg test.exe`
- Spawn process on Posix: `alicedbg ./test`
- Attach to process ID 3428: `alicedbg --attach 3428`

## Image Dumper

To invoke the object dumper, use `--dump PATH`, where PATH is a file path to a
binary image.

Examples:
- Dump headers: `alicedbg --dump alicedbg`
- Dump exports: `alicedbg --dump-exports alicedbg.exe`

# Documentation

For information about compilation, internal structures, support,
Expand Down
2 changes: 1 addition & 1 deletion src/adbg/platform.d
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ enum ADBG_CHILD_STACK_SIZE = 1024 * 1024 * 8;
//

/// Library version.
enum ADBG_VERSION = "0.3.0";
enum ADBG_VERSION = "0.4.0";

debug enum __BUILDTYPE__ = "debug"; /// Library build type.
else enum __BUILDTYPE__ = "release"; /// Ditto
Expand Down

0 comments on commit ddfa846

Please sign in to comment.