mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 09:38:16 -07:00
2fcde332ae
* init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
22 lines
934 B
Markdown
22 lines
934 B
Markdown
## Development
|
|
|
|
To develop the project, 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, and temporarily prepend the `bin` and `shims` directory of the directory to your path.
|
|
|
|
Tools we use:
|
|
|
|
- [bats](https://github.com/sstephenson/bats) for testing. Make sure
|
|
`bats test/` passes after you made your changes.
|
|
- [Shellcheck](https://github.com/koalaman/shellcheck) for static analysis of our shell scripts.
|
|
|
|
## Docker Images
|
|
|
|
The [asdf-alpine][asdf-alpine] and [asdf-ubuntu][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.
|
|
|
|
[asdf-alpine]: https://github.com/vic/asdf-alpine
|
|
[asdf-ubuntu]: https://github.com/vic/asdf-ubuntu
|