Update README

main
Elbert Alias 8 years ago
parent 1ca28b0039
commit 520b84ad4a

@ -20,28 +20,16 @@ Refer to the [wiki](https://github.com/AliasIO/Wappalyzer/wiki) for
## Getting Started ## Getting Started
This section describes how to set up a development environment. Everything you Install [Docker](https://www.docker.com/) on your system first.
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.
```shell ```shell
$ git clone https://github.com/AliasIO/Wappalyzer.git wappalyzer $ git clone https://github.com/AliasIO/Wappalyzer.git
$ cd wappalyzer $ cd Wappalyzer
$ vagrant up $ ./run links
$ vagrant ssh
``` ```
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 Please run `./run validate` before submitting a pull request.
`vagrant destroy -y && vagrant up`.

@ -2,6 +2,8 @@
cd "$(dirname $0)/.." cd "$(dirname $0)/.."
set -eu
./bin/validate ./bin/validate
echo "Prettifying apps.json..." echo "Prettifying apps.json..."