diff --git a/README.md b/README.md index 70567bc4..f4f3b3bb 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# asdf-vm [![Main workflow](https://github.com/asdf-vm/asdf/workflows/Main%20workflow/badge.svg)](https://github.com/asdf-vm/asdf/actions) +# asdf [![Main workflow](https://github.com/asdf-vm/asdf/workflows/Main%20workflow/badge.svg)](https://github.com/asdf-vm/asdf/actions) **Manage multiple runtime versions with a single CLI tool, extendable via plugins** - [docs at asdf-vm.com](https://asdf-vm.github.io/asdf/) -asdf-vm is a CLI tool that can manage multiple language runtime versions on a per-project basis. It is like `gvm`, `nvm`, `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin! +asdf is a CLI tool that can manage multiple language runtime versions on a per-project basis. It is like `gvm`, `nvm`, `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin! -## Why use asdf-vm? +## Why use asdf? - single CLI for multiple languages - consistent commands to manage all your languages @@ -19,7 +19,7 @@ asdf-vm is a CLI tool that can manage multiple language runtime versions on a pe [Please head over the documentation site for more information](https://asdf-vm.github.io/asdf/)! -- [Getting Started](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) +- [Getting Started](https://asdf-vm.github.io/asdf/#/core-manage-asdf) - [All Commands](https://asdf-vm.github.io/asdf/#/core-commands) - [All Plugins](https://asdf-vm.github.io/asdf/#/plugins-all) - [Create a Plugin](https://asdf-vm.github.io/asdf/#/plugins-create) with our [asdf-plugin-template](https://github.com/asdf-vm/asdf-plugin-template) @@ -32,5 +32,6 @@ See [CONTRIBUTING.md in the repo](https://github.com/asdf-vm/asdf/blob/master/CO ## Community & Questions -- [![Github Issues](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github Issues](https://github.com/asdf-vm/asdf/issues): report a bug or raise a feature request to the `asdf` core team -- [![StackOverflow Tag](https://icongr.am/fontawesome/stack-overflow.svg?size=16&color=808080)StackOverflow Tag](https://stackoverflow.com/questions/tagged/asdf-vm): see existing Q&A for `asdf`. Some of the core team watch this tag in addition to our helpful community + +- [![Github Issues](https://icongram.jgog.in/simple/github.svg?color=808080&size=16) Github Issues](https://github.com/asdf-vm/asdf/issues): report a bug or raise a feature request to the `asdf` core team +- [![StackOverflow Tag](https://icongr.am/fontawesome/stack-overflow.svg?size=16&color=808080) StackOverflow Tag](https://stackoverflow.com/questions/tagged/asdf-vm): see existing Q&A for `asdf`. Some of the core team watch this tag in addition to our helpful community diff --git a/docs/README.md b/docs/README.md index b4804fc6..28d2542a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ - + [](https://raw.githubusercontent.com/asdf-vm/asdf/master/README.md ':include') - + [](https://raw.githubusercontent.com/asdf-vm/asdf/master/ballad-of-asdf.md ':include') diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 3ae9d0f7..460192c7 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,6 +1,6 @@ - + -# asdf-vm +# asdf > Manage multiple runtime versions with a single CLI tool @@ -11,4 +11,4 @@ - Extend with a simple plugin system [GitHub](https://github.com/asdf-vm/asdf) -[Get Started](core-manage-asdf-vm) +[Get Started](core-manage-asdf) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index d3c8753e..64e75dc3 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,7 +1,7 @@ - **Core** -- [Manage asdf-vm](core-manage-asdf-vm) +- [Manage asdf](core-manage-asdf) - [Manage Plugins](core-manage-plugins) - [Manage Versions](core-manage-versions) - [Configuration](core-configuration) @@ -11,7 +11,7 @@ - [Creating Plugins](plugins-create) - [All Plugins](plugins-all) - **Contributing** -- [Core asdf vm](contributing-core-asdf-vm) +- [Core asdf](contributing-core-asdf) - [Documentation Site](contributing-doc-site) - [Thanks](thanks) - **Community & Questions** diff --git a/docs/contributing-core-asdf-vm.md b/docs/contributing-core-asdf.md similarity index 100% rename from docs/contributing-core-asdf-vm.md rename to docs/contributing-core-asdf.md diff --git a/docs/contributing-doc-site.md b/docs/contributing-doc-site.md index e2c3f63e..9ad8788d 100644 --- a/docs/contributing-doc-site.md +++ b/docs/contributing-doc-site.md @@ -9,7 +9,7 @@ Here is a list of improvements we are looking at making to the documentation. If - change the typography - get a logo? - improve "edit on GitHub" button/link -- add asdf-vm to awesome-docsify showcase +- add asdf to awesome-docsify showcase ## Setup Your Environment diff --git a/docs/core-manage-asdf-vm.md b/docs/core-manage-asdf.md similarity index 98% rename from docs/core-manage-asdf-vm.md rename to docs/core-manage-asdf.md index f7cab1bd..ca73c641 100644 --- a/docs/core-manage-asdf-vm.md +++ b/docs/core-manage-asdf.md @@ -1,4 +1,4 @@ -1. [Manage asdf-vm](/core-manage-asdf-vm): install `asdf` **and** add `asdf` to your shell +1. [Manage asdf](/core-manage-asdf): install `asdf` **and** add `asdf` to your shell 2. [Manage Plugins](/core-manage-plugins): add a plugin for your tool `asdf plugin add nodejs` 3. [Manage Versions](/core-manage-versions): install a version of that tool `asdf install nodejs 13.14.0` 4. [Configuration](/core-configuration): set global and project tool versions via `.tool-versions` config diff --git a/docs/core-manage-plugins.md b/docs/core-manage-plugins.md index e9acd41f..f3b5d58f 100644 --- a/docs/core-manage-plugins.md +++ b/docs/core-manage-plugins.md @@ -1,6 +1,6 @@ -Plugins are how asdf-vm understands handling different packages. +Plugins are how asdf understands handling different packages. -See [All plugins](plugins-all) for the plugins repository which lists all asdf-vm plugins we know. +See [All plugins](plugins-all) for the plugins repository which lists all asdf plugins we know. See [Creating Plugins](plugins-create) for the super-simple API for supporting more languages. diff --git a/docs/core-manage-versions.md b/docs/core-manage-versions.md index 435a742b..1de9b03f 100644 --- a/docs/core-manage-versions.md +++ b/docs/core-manage-versions.md @@ -106,13 +106,13 @@ asdf uninstall ## Shims -When asdf-vm installs a package it creates shims for every executable program in that package in a `$ASDF_DATA_DIR/shims` directory (default `~/.asdf/shims`). This directory being on the `$PATH` (by means of `asdf.sh` or `asdf.fish`) is how the installed programs are made available in the environment. +When asdf installs a package it creates shims for every executable program in that package in a `$ASDF_DATA_DIR/shims` directory (default `~/.asdf/shims`). This directory being on the `$PATH` (by means of `asdf.sh` or `asdf.fish`) is how the installed programs are made available in the environment. The shims themselves are really simple wrappers that `exec` a helper program `asdf exec` passing it the name of the plugin and path to the executable in the installed package that the shim is wrapping. The `asdf exec` helper determines the version of the package to use (as specified in `.tool-versions` file, selected by `asdf local ...` or `asdf global ...`), the final path to the executable in the package installation directory (this can be manipulated by the `exec-path` callback in the plugin) and the environment to execute in (also provided by the plugin - `exec-env` script), and finally it executes it. -!> Note that because this system uses `exec` calls, any scripts in the package that are meant to be sourced by the shell instead of executed need to be accessed directly instead of via the shim wrapper. The two asdf-vm commands: `which` and `where` can help with this by returning the path to the installed package: +!> Note that because this system uses `exec` calls, any scripts in the package that are meant to be sourced by the shell instead of executed need to be accessed directly instead of via the shim wrapper. The two asdf commands: `which` and `where` can help with this by returning the path to the installed package: ```shell # returns path to main executable in current version diff --git a/docs/index.html b/docs/index.html index 1a65c9ab..317ac6e1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - asdf vm - An extendable version manager + asdf - An extendable version manager