Skip to content

Commit c74ab9a

Browse files
authored
Expand the readme a little (#36)
1 parent 1d6ad6d commit c74ab9a

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@ A Rust library for interacting with debugging information of compiled artifacts
1010

1111
⚠️ **Experimental Status**: This library is in early development (0.0.x). The API is unstable and subject to breaking changes.
1212

13-
## LLDB Integration
1413

15-
[![asciicast](https://asciinema.org/a/CfSY9cLqPwkkB1qxPJrLA302D.svg)](https://asciinema.org/a/CfSY9cLqPwkkB1qxPJrLA302D)
14+
> [!IMPORTANT]
15+
> See the [announcement post](https://www.samjs.io/blog/rudy) for more on the rationale/design behind Rudy.
1616
17-
### Installation
17+
## LLDB Extension
18+
19+
We also provide an example `rudy-lldb` extension that brings the capabilities of `rudy-db` to the `lldb` debugger.
20+
21+
Here's a short demo:
22+
23+
[![rudy-lldb demo](https://asciinema.org/a/CfSY9cLqPwkkB1qxPJrLA302D.svg)](https://asciinema.org/a/CfSY9cLqPwkkB1qxPJrLA302D)
24+
25+
### Installation (rudy-lldb)
1826

1927
For now, the installation process is a little manual:
2028

@@ -37,7 +45,7 @@ For now, the installation process is a little manual:
3745
- Cross-platform support (x86_64, aarch64 on macOS, Linux)
3846

3947

40-
## Basic Usage
48+
## Basic Usage (rudy-db)
4149

4250
Here's a simple example of loading a binary and resolving type information from a memory address:
4351

@@ -50,10 +58,10 @@ fn main() -> Result<()> {
5058
let mut db = DebugDb::new();
5159

5260
// Get debug information for a binary
53-
let debug_info = DebugInfo::new(&db, "/path/to/binary").unwrap();
61+
let debug_info = DebugInfo::new(&db, "/path/to/binary")?;
5462

5563
// Find a function by name
56-
let function = db.find_function_by_name("my_function").unwrap();
64+
let function = db.find_function_by_name("my_function")?;
5765

5866
// get all params:
5967
for param in &function.params {

0 commit comments

Comments
 (0)