kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #164 from ypid/docs_improvements

Browse Source 
Docs improvements
This commit is contained in:
Daniel Perez 2017-05-15 11:17:25 +09:00 committed by GitHub
commit 82f399c6b3
4 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -49,7 +49,7 @@ mkdir -p ~/.config/fish/completions; and cp ~/.asdf/completions/asdf.fish ~/.con
Plugins are how asdf understands how to handle different packages. Below is a list of plugins for languages. There is a [super-simple API](https://github.com/asdf-vm/asdf/blob/master/docs/creating-plugins.md) for supporting more languages.
| Language | Repository | CI Status
|-----------|-------------|----------
|-----------|-------------|----------
| Clojure | [vic/asdf-clojure](https://github.com/vic/asdf-clojure) | [![Build Status](https://travis-ci.org/vic/asdf-clojure.svg?branch=master)](https://travis-ci.org/vic/asdf-clojure)
| Crystal | [marciogm/asdf-crystal](https://github.com/marciogm/asdf-crystal) | [![Build Status](https://travis-ci.org/marciogm/asdf-crystal.svg?branch=master)](https://travis-ci.org/marciogm/asdf-crystal)
| D (DMD) | [sylph01/asdf-dmd](https://github.com/sylph01/asdf-dmd) | [![Build Status](https://travis-ci.org/sylph01/asdf-dmd.svg?branch=master)](https://travis-ci.org/sylph01/asdf-dmd)
@ -213,14 +213,14 @@ legacy_version_file = yes
## Credits
Me ([@HashNuke](http://github.com/HashNuke)), High-fever, cold, cough.
Me ([@HashNuke](https://github.com/HashNuke)), High-fever, cold, cough.
Copyright 2014 to the end of time ([MIT License](https://github.com/asdf-vm/asdf/blob/master/LICENSE))
### Maintainers
- [@HashNuke](http://github.com/HashNuke)
- [@tuvistavie](http://github.com/tuvistavie)
- [@HashNuke](https://github.com/HashNuke)
- [@tuvistavie](https://github.com/tuvistavie)
- [@Stratus3D](https://github.com/Stratus3D)
- [@vic](https://github.com/vic)

36
ballad-of-asdf.md
View File

@ -1,30 +1,30 @@
# Ballad of asdf
> Once upon a time there was a programming language
There were many versions of it
So people wrote a version manager for it
To switch between versions for projects
Different, old, new.
> Once upon a time there was a programming language
There were many versions of it
So people wrote a version manager for it
To switch between versions for projects
Different, old, new.
> Then there came more programming languages
So there came more version managers
And many commands for them
> Then there came more programming languages
So there came more version managers
And many commands for them
> I installed a lot of them
I learnt a lot of commands
I learnt a lot of commands
> Then I said, just one more version manager
Which I will write instead
> Then I said, just one more version manager
Which I will write instead
> So, there came another version manager
**asdf version manager** - <https://github.com/HashNuke/asdf>
> So, there came another version manager
**asdf version manager** - <https://github.com/HashNuke/asdf>
> A version manager so extendable
for which anyone can create a plugin
To support their favourite language
No more installing more version managers
> A version manager so extendable
for which anyone can create a plugin
To support their favourite language
No more installing more version managers
Or learning more commands
---
*This was the mail I wrote to a few friends to tell them about the project. Thanks to [@roshanvid](http://twitter.com/roshanvid) for suggesting that this go into the readme*
*This was the mail I wrote to a few friends to tell them about the project. Thanks to [@roshanvid](https://twitter.com/roshanvid) for suggesting that this go into the readme*

6
docs/creating-plugins.md
View File

@ -17,7 +17,7 @@ All scripts except `bin/list-all` will have access to the following env vars to
#### bin/list-all
Must print a string with a space-seperated list of versions. Example output would be the following:
Must print a string with a space-separated list of versions. Example output would be the following:
```
1.0.1 1.0.2 1.3.0 1.4
@ -36,7 +36,7 @@ This script should install the version, in the path mentioned in `ASDF_INSTALL_P
#### bin/list-bin-paths
List executables for the specified version of the tool. Must print a string with a space-seperated list of dir paths that contain executables. The paths must be relative to the install path passed. Example output would be:
List executables for the specified version of the tool. Must print a string with a space-separated list of dir paths that contain executables. The paths must be relative to the install path passed. Example output would be:
```
bin tools veggies
@ -56,7 +56,7 @@ Uninstalls a specific version of a tool.
#### bin/list-legacy-filenames
Register additional setter files for this plugin. Must print a string with a space-seperated list of filenames.
Register additional setter files for this plugin. Must print a string with a space-separated list of filenames.
```
.ruby-version .rvmrc

6
lib/commands/reshim.sh
View File

@ -97,17 +97,17 @@ generate_shims_for_version() {
local install_path=$(get_install_path $plugin_name $install_type $version)
if [ -f ${plugin_path}/bin/list-bin-paths ]; then
local space_seperated_list_of_bin_paths=$(
local space_separated_list_of_bin_paths=$(
export ASDF_INSTALL_TYPE=$install_type
export ASDF_INSTALL_VERSION=$version
export ASDF_INSTALL_PATH=$install_path
bash ${plugin_path}/bin/list-bin-paths
)
else
local space_seperated_list_of_bin_paths="bin"
local space_separated_list_of_bin_paths="bin"
fi
IFS=' ' read -a all_bin_paths <<< "$space_seperated_list_of_bin_paths"
IFS=' ' read -a all_bin_paths <<< "$space_separated_list_of_bin_paths"
for bin_path in "${all_bin_paths[@]}"; do
for executable_file in $install_path/$bin_path/*; do