maelstrom/ykit
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

fixed readme

Browse source
This commit is contained in:
maelstrom 2024-07-27 19:37:39 +02:00
parent 91094491f1
commit 6c7fb26095
2 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -5,3 +5,6 @@ tools/*
!tools/smali-2.5.2.jar
!tools/apktool_2.9.3.jar
!tools/apksigner.jar
.idea
*.iml

10
README.md
View file

@ -20,11 +20,17 @@ Use whichever you prefer.
Build commands and flags:
`./build.sh extract` - Extracts the apk's contents into `build/extracted`
`./build.sh clean` - Cleans up the workspace by deleting the `build` directory
`./build.sh assemble` - Assembles the ykit apk without signing or aligning it
`./build.sh build [flags]` - Buildss the apk and aligns and signs it using the specified key.
`./build.sh build [flags]` - Builds the apk and aligns and signs it using the specified key.
Build flags:
`a` - Deploy to android studio in `~/ApkProjects/tumblr-ykit`. To generate one, open AS, and load the apk. From then on you will not need to repeat this step unless you want to analyze the code (TODO: This explanation is garbage.)
`r` - Sign using release keystore `keystores/release.keystore` (You will have to create it yourself)
`r` - Sign using the debug keystore `keystores/debug.keystore` (It will be created automatically)
`d` - Sign using the debug keystore `keystores/debug.keystore` (It will be created automatically)