diff --git a/README.md b/README.md index f8351dc..1c61036 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ # VEJ Very Easy Job — A program to simplify the process of taint analysis using FlowDroid for android apps -#### Dependencies to be installed in environment: - +### Dependencies to be installed in environment 1. [Java 8 Runtime Environment](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) 2. [Python 3](https://www.python.org/download/releases/3.0/#download) -#### Usage: - +### Usage 1. Place the apk file(s) into the "apk" folder 2. Run the run.py (Windows) or run-mac.py (Mac) for taint analysis 3. Result, if any, will be placed in "sootOutput" folder -#### To generate source sink list for a new android platform: +### To generate source sink list for a new android platform 1. Create a new directory under android-platforms with the appropriate name + 1. You must use the android-\ syntax to ensure that VEJ can find your android-platform 2. Place android.jar into the new directory. 1. Ensure that it is a fully-implemented Android JAR file and not one that ships with Google's Android SDK 2. Platform JAR files that ships with Google's Android SDK contains method stubs and are not suitable for SuSi 3. Fully-implemented Android JAR files can be extracted from an emulator or a real phone. -3. Run the susi.bat (Windows) or runSuSi.sh (Mac) to generate the new source sink lists \ No newline at end of file +3. Run the susi.bat (Windows) or susi.sh (Mac) to generate the new source sink lists