add readme

This commit is contained in:
vexdevt 2024-05-11 15:17:52 -05:00
commit c3098771c2
1 changed files with 30 additions and 0 deletions

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# bnyx
a boot image extraction utility, simple enough ( you dont probably need this if you are a eagler developer. ).
bnyx can do basic stuff like :
- print out cmdline
- extract kernel, ramdisk
- print out kernel load adress
- print out ramdisk load addr
etc..
# how to extract your boot image?
Boot to recovery ( twrp, orangefox whatever ), Open terminal in the recovery and run the command :
```dd if=/dev/block/bootdevice/by-name/boot of=/sdcard/boot.img```
<br> for zone optional double a/b partition devices :
```dd if=/dev/block/bootdevice/by-name/boot_a of=/sdcard/boot.img```
# how to use the damn program?
drop your boot image to bnyx and it will extract the contents inside automatically for you <br>
if you just want the cmdline or ramdisk, kernel etc... you can specify the arguments.
```
--boot-args
--ramdisk
--kernel
--pagesize
--kernel-load-addr
--ramdisk-load-addr
```
# acknowledgments
https://android.googlesource.com/platform/system/tools/mkbootimg/+/refs/heads/main/include/bootimg/bootimg.h <br>
https://github.com/anestisb/android-unpackbootimg/blob/master/mkbootimg.py <br>
https://github.com/csimmonds/boot-extract <br>