diff --git a/README.md b/README.md index dbc8eaa5c..1fcef6cba 100644 --- a/README.md +++ b/README.md @@ -20,28 +20,16 @@ Refer to the [wiki](https://github.com/AliasIO/Wappalyzer/wiki) for ## Getting Started -This section describes how to set up a development environment. Everything you -need is contained in a [Docker image](https://registry.hub.docker.com/u/wappalyzer/dev/) -which is managed by Vagrant. - -Running this environment is optional but recommended as it provides some helpful tools. - -First, install [Docker](https://www.docker.com/) and [Vagrant](https://www.vagrantup.com/) -on your system. - -Clone the Wappalyzer repository and open the newly created directory in a -terminal. Run `vagrant up` to start the environment. - -Run `vagrant ssh` to access the environment and read usage instructions. +Install [Docker](https://www.docker.com/) on your system first. ```shell -$ git clone https://github.com/AliasIO/Wappalyzer.git wappalyzer -$ cd wappalyzer -$ vagrant up -$ vagrant ssh +$ git clone https://github.com/AliasIO/Wappalyzer.git +$ cd Wappalyzer +$ ./run links ``` -To stop the environment, run `vagrant halt`. +The `links` command creates symlinks for files that shared between the various +drivers (i.e. different platforms). If your file system does not support +symlinks, you need to manually copy these files (see `bin/links`). -If a new Docker image becomes available, rebuild the environment with -`vagrant destroy -y && vagrant up`. +Please run `./run validate` before submitting a pull request. diff --git a/bin/build b/bin/build index af6a94195..44f875379 100755 --- a/bin/build +++ b/bin/build @@ -2,6 +2,8 @@ cd "$(dirname $0)/.." +set -eu + ./bin/validate echo "Prettifying apps.json..." diff --git a/bin/links b/bin/links index c7905c0c4..368ce0e66 100755 --- a/bin/links +++ b/bin/links @@ -4,8 +4,8 @@ cd "$(dirname $0)/../src" echo "Creating links..." -ln -nsf ../../apps.json drivers/npm -ln -nsf ../../wappalyzer.js drivers/npm +ln -nsf ../../apps.json drivers/npm +ln -nsf ../../wappalyzer.js drivers/npm ln -nsf ../../apps.json drivers/webextension ln -nsf ../../../wappalyzer.js drivers/webextension/js