Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: Add installation and usage instructions #37

Merged
merged 1 commit into from
Mar 20, 2023
Merged

README.md: Add installation and usage instructions #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

An android OTA payload dumper written in Go.

Download prebuilt binaries for macOS, Windows and Linux via [here](https://github.com/ssut/payload-dumper-go/releases).

## Features

![screenshot](https://i.imgur.com/IJtwoWU.png)
Expand All @@ -22,6 +20,38 @@ See how fast payload-dumper-go is: https://imgur.com/a/X6HKJT4. (MacBook Pro 16-

- Incremental OTA(delta) payload is not supported.

## Installation

0. Download the latest binary for your platform from [here](https://github.com/ssut/payload-dumper-go/releases) and extract the contents of the downloaded file to a directory on your system.

### Linux and OSX

1. Make sure the extracted binary file has executable permissions. You can use the following command to set the permissions if necessary:
```
chmod +x payload-dumper-go
```
2. Run the following command to add the directory path to your system's PATH environment variable:
```
export PATH=$PATH:/path/to/payload-dumper-go
```
Note: This command sets the PATH environment variable only for the current terminal session. To make it permanent, you need to add the command to your system's profile file (e.g. .bashrc or .zshrc for Linux/Unix systems).

### Windows

1. Open the Start menu and search for "Environment Variables".
2. Click on "Edit the system environment variables".
3. Click on the "Environment Variables" button at the bottom right corner of the "System Properties" window.
4. Under "System Variables", scroll down and click on the "Path" variable, then click on "Edit".
5. Click "New" and add the path to the directory where the extracted binary is located.
6. Click "OK" on all the windows to save the changes.

## Usage

Run the following command in your terminal:
```
payload-dumper-go /path/to/payload.bin
```

## Sources

https://android.googlesource.com/platform/system/update_engine/+/master/update_metadata.proto
Expand Down