Commit 41b19ed1 authored by Jason Hiser's avatar Jason Hiser 🚜

Update README.md

parent da918455
Pipeline #2712 passed with stages
in 7 minutes and 51 seconds
......@@ -39,6 +39,8 @@ This transform is only useful for demonstration and testing.
### Docker (Recommended)
Setup docker on your Linux-based host. See the [Docker homepage](https://docs.docker.com/install/linux/docker-ce/ubuntu/) for additional details on how to achieve this.
The easiest way to test these transforms is to use Zephyr's docker registry:
```
......@@ -48,6 +50,8 @@ docker run -it git.zephyr-software.com:4567/opensrc/irdb-sdk/zipr-dev <args>
The recommended value for `<args>` is `help`. Follow the directions in the help to log in to the docker image. Once logged in,
you can `cd irdb-cookbook-examples` and run `scons`.
At this point, you should have the cookbook installed and built, along with the `pszr` infrascture in your `$PATH`.
### Manually (Not recommended)
......@@ -68,10 +72,15 @@ available, however, they are available via this reduced docker image: `git.zephy
To use these transforms, one should:
1. Install and run `pszr` with the proper step enabled, e.g.:
1. Run `pszr` with the proper step enabled. For example, to enable the stack stamping transform, one should:
```
/path/to/pszr --step stack_stamp /bin/ls ./ls.stamped
pszr --step stack_stamp /bin/ls ./ls.stamped
```
This command should create a new ELF binary file called `ls.stamped` that's functionally equivilent to `/bin/ls`, but with stack stamping applied to return addresses.
Transformation steps can be combined and are applied in the order specified. See `pszr --help` for additional usage information.
Documentation on obtaining, building and running pszr without docker is not yet available.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment