V1

Author: slinan

LICENSE

@@ -1,3 +1,46 @@
-# Rip
-Ripper that extracts augmented models from Android apps.
-Coming soon!
+# RIP
+### 2018, Universidad de los Andes - The Software Design Lab
+
+## Dependencies
+
+To build the .JAR you must install Java 8 JDK and Gradle 4.5.1 
+
+Gradle will install the following dependencies:
+```
+* JUnit (4.12)
+* Apache Commons IO (2.6)
+* Jackson-Core (2.9.4)
+* Log4J (2.10.0)
+```
+## Installation
+
+To build the project run the command:
+```
+gradle jarjar
+```
+The JAR file will be generated at
+```
+build/libs/RIP.jar
+```
+Set the following environment variables
+
+```
+APK_LOCATION  
+AAPT_LOCATION
+```
+where APK_LOCATION corresponds to the path of the apk to be analyzed, and AAPT_LOCATION is where AAPT is located.
+
+**Example:**
+
+```
+APK_LOCATION= /home/maria/Documentos/RIP/androidApps/Spunky2.apk	
+AAPT_LOCATION= /home/maria/Android/Sdk/build-tools/27.0.3/aapt
+
+```
+
+## Running
+
+Before running you must have an android emulator turned on or a device connected with the debugging option enabled.
+To run an android emulator from the terminal you can use the command **emulator -list-avds** (under Android/sdk/tools/) to check the available devices. Then, you can turn on one device by running the **emulator -avd EMULATOR_NAME command**.
+
+To run the jar file, go to the folder where it was generated at (build/libs). Then, run the command `java -jar RIP.jar` to start the execution. 

README.md

@@ -0,0 +1,44 @@
+/*
+ * This build file was generated by the Gradle 'init' task.
+ *
+ * This generated file contains a sample Java Library project to get you started.
+ * For more details take a look at the Java Libraries chapter in the Gradle
+ * user guide available at https://docs.gradle.org/3.5/userguide/java_library_plugin.html
+ */
+
+// Apply the java-library plugin to add support for Java Library
+apply plugin: 'java-library'
+
+// In this section you declare where to find the dependencies of your project
+repositories {
+    // Use jcenter for resolving your dependencies.
+    // You can declare any Maven/Ivy/file repository here.
+    mavenCentral()
+    jcenter()
+}
+    
+    task jarjar(type: Jar) {
+    manifest {
+        attributes "Main-Class": "main.Rip"
+    }
+    baseName = 'RIP'
+    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
+    with jar
+}
+
+
+dependencies {
+    compile 'commons-io:commons-io:2.6'
+    compile 'com.fasterxml.jackson.core:jackson-core:2.9.4'
+    compile 'com.fasterxml.jackson.core:jackson-databind:2.9.4'
+    compile 'com.googlecode.json-simple:json-simple:1.1.1'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.11.1'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.11.1'
+    compile group: 'org.eclipse.jetty', name:'jetty-server', version: '9.2.3.v20140905'
+    compile group: 'org.eclipse.jetty', name:'jetty-servlet', version: '9.2.3.v20140905'
+    compile group: 'me.tongfei', name:'progressbar', version: '0.5.5'
+
+    // Use JUnit test framework
+    testImplementation 'junit:junit:4.12'
+}
+