Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
msuiche authored Jan 17, 2023
1 parent 5a6de4c commit 56fcdc0
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ In short, why you should use this utility:
- Rust. This utility has been written in Rust, meaning that it is not only memory-safe - it can later be expanded to support additional remote streaming options.
- User-land. This utility relies on `/proc/kcore` meaning that no Linux kernel module is required. Root permission is, however, needed.

## Building
1. [Install Rust](https://www.rust-lang.org/tools/install)
2. Run the following command
```
cargo build --release
```
`cargo build --release` puts the resulting binary in `target/release` instead of `target/debug`.

Compiling in debug mode is the default for development-- compilation time is shorter since the compiler doesn't do optimizations, but the code will run slower. Release mode takes longer to compile, but the code will run faster.

## What are Kernel crash dumps?
More information can be found on the [Ubuntu Documentation](https://ubuntu.com/server/docs/kernel-crash-dump).

Expand Down Expand Up @@ -201,4 +211,4 @@ For help, type help(drgn).
</details>

# Contributing / Feedback
If you encounter any bugs, please file an issue in the [issues](https://github.com/magnetforensics/dumpit-linux) section of the project.
If you encounter any bugs, please file an issue in the [issues](https://github.com/magnetforensics/dumpit-linux) section of the project.

0 comments on commit 56fcdc0

Please sign in to comment.