diff --git a/README.md b/README.md index b659d33..0530430 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,43 @@ # 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/). +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. ## Installation -### Linux/MacOs (mono) +### First Time + +Ensure that both + +* [mono](https://www.mono-project.com/) (tested with version 5.14) *and* +* [dotnet SDK](https://www.microsoft.com/net/download) (tested with version 2.1) + +are installed. Moreover, [FAKE] needs to be installed + + dotnet tool install fake-cli -g + +and added to the `PATH` so that you can call `fake` on the command line. +This might require + + export PATH=$HOME/.dotnet/tools/fake:$PATH After cloning the repository, call ./configure.sh +to initialize the `paket` configuration. + +### (Re-) Compiling + After that, the project can be build using ./build.sh -### Windows +### Note for Windows Users -On Windows (untested), you need to set up the initial project manually: +On Windows (untested), `configure.sh` can be replaced by configuring +`paket` manually .paket/paket.bootstrapper.exe .paket/paket.exe install