Create README.MD

Author: StevenArzt

README.MD

@@ -0,0 +1,61 @@
+# FlowDroid Data Flow Analysis Tool
+
+This repository hosts the FlowDroid data flow analysis tool. FlowDroid statically computes data flows in Android apps and Java programs.
+Its goal is to provide researchers and practitioners with a tool and library on which they can base their own research projects and
+product implementations. We are happy to see that FlowDroid is now widely used in academia as well as industry.
+
+## Using The Data Flow Tracker
+
+You can use FlowDroid either through its command-line interface (module soot-infoflow-cmd) or as a library. In general, if you would
+like to implement something and need a data flow tracker as a component, you are better off by integrating the FlowDroid modules as
+JAR files. If you just need the results quickly, simply run the command-line interface.
+
+FlowDroid is supported on Windows, Mac OS, and Linux.
+
+## Building The Tool
+
+From version 2.5 on, FlowDroid is built using Maven. Use
+
+```
+EXPORT ANDROID_JARS=<Android JAR folder>
+EXPORT DROIDBENCH=<DroidBench folder>
+mvn install
+```
+
+to build the tool and run all unit tests. The Android JAR folder is the "platforms" directory inside your Android SDK installation
+folder. The DroidBench folder is the location of DroidBench, our micro-benchmark suite. These two environment variables are only
+required for running the unit tests.
+
+If you do want DroidBench, or are in a hurry and just want to build the tool without the tests (they can take
+quite some time to complete, we have more than 400 of them), try
+
+```
+mvn -DskipTests install
+```
+
+Either way, you will find the built JAR files in the "target" folder of the respective modules. Maven should take care of all
+dependencies that are required for the build. Unless you need to build FlowDroid on a machine without an Internet connection,
+thing should be pretty easy.
+
+## Publications
+
+If you want to read the details on how FlowDroid works, <a href="http://tuprints.ulb.tu-darmstadt.de/5937/">the PhD thesis of
+Steven Arzt</a> is a good place to start.
+
+## Contributing to FlowDroid
+
+Contributions are always welcome. FlowDroid is an open source project that we published in the hope that it will be useful to
+the research community as a whole. If you have a new feature of a bug fix that you would like to see in the official code
+repository, please open a merge request here on Github and contact us (see below) with a short description of what you have
+done.
+
+## License
+
+FlowDroid is licensed
+under the LGPL license, see LICENSE file. This basically means that you are free to use the tool (even in commercial, closed-source
+projects). However, if you extend or modify the tool, you must make your changes available under the LGPL as well. This ensures that
+we can continue to improve the tool as a community effort.
+
+## Contact
+
+If you experience any issues, you can ask for help on the Soot mailing list. You can also contact us at [email protected].