diff --git a/README.md b/README.md index e294196a..9a00f051 100644 --- a/README.md +++ b/README.md @@ -220,6 +220,15 @@ legacy_version_file = yes The [asdf-alpine](https://github.com/vic/asdf-alpine) and [asdf-ubuntu](https://github.com/vic/asdf-ubuntu) projects are an ongoing effort to provide Dockerized images of some asdf tools. You can use these docker images as base for your development servers, or for running your production apps. +## Development + +To develop the project, you can simply `git clone` the master branch. +If you want to try out your changes without making change to your installed `asdf`, +you can set the `$ASDF_DIR` variable to the path where you cloned the repository. + +We use [bats](https://github.com/sstephenson/bats) for testing, +so make sure `bats test/` passes after you made your changes. + ## Credits Me ([@HashNuke](https://github.com/HashNuke)), High-fever, cold, cough.