diff --git a/README.md b/README.md index a6c41c6..5ea3ee2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ # Dummy Android -## Requirements +## Docker + +This project relies on Docker to allow development using the same environment as the CI server (Jenkins). + +### Requirements - Android SDK - Docker (18.09.1+) - Docker Composer (1.21.0+) -## Configuration +### Configuration By default, Android SDK is expected under `~/android/sdk`. It is possible to adapt this path in `docker-compose.yml`. But it may also be specified in your `local.properties`! -## Usage +### Usage The following command should build (if required) and start a shell session inside the container: @@ -33,3 +37,16 @@ bundle update fastlane bundle update ``` + +## Jenkins + +The project is designed to be build from a Jenkins server, which will provide the above requirements. + +### Dependencies + +- [Jenkins Lazy Lib](https://github.com/digital-me/jenkins-lib-lazy) +- [Jenkins Custom Lib]() + +### Usage + +Like all projects using lazyLib, each build can be altered with LAZY_ENV parameter.