chore(kb): improve readibility

This commit is contained in:
Michele Cereda
2024-05-15 18:59:18 +02:00
parent cec7de5c31
commit 610e824251

View File

@@ -1,8 +1,7 @@
# ASDF # ASDF
CLI tool to manage multiple language runtime versions on a per-project basis. It works like `gvm`, `nvm`, `rbenv` and `pyenv` (and more) all in one. CLI tool to manage multiple language runtime versions on a per-project basis. It works like `gvm`, `nvm`, `rbenv`,
`pyenv` and others, all in one.
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr) 1. [TL;DR](#tldr)
1. [Installation](#installation) 1. [Installation](#installation)
@@ -135,9 +134,11 @@ python system 3.11.0 3.10.9 3.9.7
The versions listed in such file can be: The versions listed in such file can be:
- an actual version, like `3.10.9`; plugins that support downloading binaries, will download that versions' binaries - an actual version, like `3.10.9`; plugins that support downloading binaries, will download that versions' binaries
- a git reference, like `ref:v1.0.2-a` or `ref:39cb398vb39`; plugins will download the given tag/commit/branch from github and compile the executable file - a git reference, like `ref:v1.0.2-a` or `ref:39cb398vb39`; plugins will download the given tag/commit/branch from
github and compile the executable file
- a path, like `path:~/src/elixir`; plugins will reference this path to a (custom, compiled) version of the executable - a path, like `path:~/src/elixir`; plugins will reference this path to a (custom, compiled) version of the executable
- the `system` keyword; this causes asdf to passthrough to the version of the tool present on the host system and avoid those which are managed by asdf - the `system` keyword; this causes asdf to passthrough to the version of the tool present on the host system and avoid
those which are managed by asdf
## Further readings ## Further readings
@@ -147,13 +148,14 @@ The versions listed in such file can be:
- [`.tool-versions` example][.tool-versions example] - [`.tool-versions` example][.tool-versions example]
<!-- <!--
References Reference
═╬═Time══
--> -->
<!-- Files -->
[.tool-versions example]: ../examples/dotfiles/.tool-versions
<!-- Upstream --> <!-- Upstream -->
[github]: https://github.com/asdf-vm/asdf [github]: https://github.com/asdf-vm/asdf
[homepage]: https://asdf-vm.com/ [homepage]: https://asdf-vm.com/
[plugins list]: https://github.com/asdf-vm/asdf-plugins [plugins list]: https://github.com/asdf-vm/asdf-plugins
<!-- Files -->
[.tool-versions example]: ../examples/dotfiles/.tool-versions