diff options
| author | mo khan <mo.khan@gmail.com> | 2020-11-10 14:42:05 -0700 |
|---|---|---|
| committer | mo khan <mo.khan@gmail.com> | 2020-11-10 14:42:05 -0700 |
| commit | f524c8e8ab1ef3d5901dfc460808a891c7f01d04 (patch) | |
| tree | 76250d3697c07587eeae44760de40527dae20100 | |
| parent | 191185c4303768c6d9a1431c35143501c06ee4d7 (diff) | |
docs: add a getting started section to the README
| -rw-r--r-- | README.md | 25 |
1 files changed, 22 insertions, 3 deletions
@@ -23,6 +23,27 @@ only, but this may change in the future. ## Development +### Getting Started + +Install [Docker](https://docs.docker.com/engine/installation/). + +```sh +$ git clone git@gitlab.com:gitlab-org/security-products/analyzers/license-finder.git +$ cd license-finder +``` + +Download the latest version of the Docker image. + +```sh +$ ./bin/docker-pull +``` + +Launch a shell in the Docker container. + +```sh +$ ./bin/docker-shell +``` + ### Running the application License Management is a Docker image. You can build it like this from the project root: @@ -42,7 +63,6 @@ $ docker run --rm --volume "/path/to/my/project":/code --env CI_PROJECT_DIR=/cod You can run the tests from inside a docker container: ```sh -$ ./bin/docker-build $ ./bin/docker-shell $ ./bin/setup $ ./bin/test [path to file] @@ -52,7 +72,6 @@ If you need to debug any specific issues you can do this from within the docker following these steps: ```sh -$ ./bin/docker-build $ ./bin/docker-shell $ enable_dev_mode $ bundle open license_finder @@ -80,7 +99,7 @@ The following table shows which languages and package managers are supported. | .NET | [.NET Core CLI][dotnet_core], [Nuget][nuget] | | C/C++ | [Conan][conan] | | Go | [Go modules][gomod], [Godep][godep], go get | -| Java | [Gradle][gradle], [Maven v3.2.5+)][maven] | +| Java | [Gradle][gradle], [Maven v3.2.5+][maven] | | JavaScript | [npm][npm], [yarn][yarn], [Bower][bower] | | PHP | [composer][composer] | | Python | [pip][pip], [pipenv][pipenv] | |