From 6c7fb260957d0d2f597b542fe79ad10fbb9c3262 Mon Sep 17 00:00:00 2001 From: maelstrom Date: Sat, 27 Jul 2024 19:37:39 +0200 Subject: [PATCH] fixed readme --- .gitignore | 3 +++ README.md | 10 ++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index f9e5805..2bf253f 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,6 @@ tools/* !tools/smali-2.5.2.jar !tools/apktool_2.9.3.jar !tools/apksigner.jar + +.idea +*.iml \ No newline at end of file diff --git a/README.md b/README.md index fa35fca..43bddfb 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file + +`d` - Sign using the debug keystore `keystores/debug.keystore` (It will be created automatically) \ No newline at end of file