diff --git a/README.md b/README.md index f449072..26186d3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,39 @@ # ExtensionDsLab +ExtensionDsLab is a data science and machine learning framework for analyzing +security and privacy related properties of the browser extensions (and Chrome +Apps) offered in the [Chrome Web Store](https://chrome.google.com/webstore/). + +# Dependencies +Dependencies are managed by paket, with the exception of +* the SQLite libraries required by the SQLProvider. For Mono, + ``configure.sh`` tries to set up everything nicely using a + system-wide installed ``Mono.Data.Sqlite.dll``. If this fails, + please follow the steps documented at the + [SQLProvider website](http://fsprojects.github.io/SQLProvider/core/sqlite.html). +* the ``sqlite3`` binary is used for creating an empty data base used + by the SQL type provider # Installation -``` -build.sh // on mono (e.g., on Linux) -build.cmd // on windows -``` +* On Linux/MacOs using mono: + After cloning the repository, call + ``` + ./configure.sh + ``` + After that, the project can be build using + ``` + ./build.sh + ``` +* On Windows (untested), you need to set up the initial project + manually: + ``` + type src/resources/scholar-kpi-schema.sql | sqlite3 src/resources/scholar-kpi-schema.sqlite + .paket/paket.bootstrapper.exe + .paket/paket.exe install + ```` + After that, the project can be build using + ``` + build.cmd + ``` ## Team * [Achim D. Brucker](http://www.brucker.ch/)