From 627143595fbe768523f19d3868a29afa202825d5 Mon Sep 17 00:00:00 2001 From: Caleb Fenton Date: Fri, 7 Feb 2020 11:17:00 +0200 Subject: [PATCH] Add usage and building --- sdbg/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/sdbg/README.md b/sdbg/README.md index e219ca69f..2dd12ec1f 100644 --- a/sdbg/README.md +++ b/sdbg/README.md @@ -6,3 +6,40 @@ Right now, it's only an experiment, so if you have feature suggestions, feel fre Since sdbg is powered by SmaliVM, it has all of its strengths and weaknesses. It can handle unknown values and parameters by taking every execution path, which is cool. But it's also possible to get stuck in infinite loops and debugging multiple execution paths is tricky. +## Building + +From the root of this repository: + +```bash +./gradlew :sdbg:fatjar +``` + +The full jar will be in `sdbg/build/libs/`. + +## Usage + +```plaintext +Usage:
[-hVv] input-path method-signature +Smali DeBuGger (SDBG) + input-path Input directory containing Smali + method-signature Method signature to execute + -h, --help Show this help message and exit. + -v, --verbose Specify multiple -v options to increase verbosity. + For example, `-v -v -v` or `-vvv` + -V, --version Print version information and exit. +``` + +```plaintext +Commands: + help Displays help information about the specified command + cls, clear Clears the screen + list, l List source code + where, w Shows current instruction index and which function you are in + step, s Step to next line of code including stepping into methods + next, n Execute next line of code without entering methods + info, i List information about target + print, p Print value stored in variable or field + break, b Suspend program at specified function, instruction index, or + index offset + continue, c Continue executing until next break point +```