Skip to content

Commit 6fdd290

Browse files
committed
docs: Add asciinema and tweak wording
1 parent ad65327 commit 6fdd290

2 files changed

Lines changed: 18 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,28 @@ STATUS: IN DEVELOPMENT
66

77
## Why?
88

9-
- Your OS's package manager doesn't contain the latest (or multiple) $language versions
10-
- And/or you don't trust random APT repositories, AUR packages, etc.
11-
- You want an OS independent way to install and switch between $language versions
12-
- And/or if you don't want to remember how to use `update-alternatives`, `archlinux-java`, etc.
9+
- Your OS's package manager doesn't contain the latest (or multiple) `$language` versions
10+
- And/or you don't trust random / less maintained APT repositories, AUR packages, etc.
11+
- You want an OS independent way to install and switch between `$language` versions
12+
- And/or if you don't want to remember / forget how to use `update-alternatives`, `archlinux-java`, etc.
1313
- You are tired of installing and configuration version managers for every single language
14-
- You believe any of the following is overkill, slow, bloated, or is poorly coded
15-
- [Nix](https://nixos.org)
16-
- [Guix](https://guix.gnu.org/en/download)
17-
- [asdf](https://github.com/asdf-vm/asdf)
18-
- [sdkman](https://github.com/sdkman/sdkman-cli)
19-
- [Docker](https://www.docker.com) (or containers in general)
14+
- And/or you think each version manager comes with its own class of bugs / bad dx, etc.
15+
16+
I didn't like existing solutions such as [asdf](https://github.com/asdf-vm/asdf) or [sdkman](https://github.com/sdkman/sdkman-cli). asdf was too buggy and I disliked the coding style and architecture. sdkman is better but it felt too bloated, complex, and Java-centric. Other solutions like [Nix](https://nixos.org), [Guix](https://guix.gnu.org/en/download), and [Docker](https://www.docker.com) solve the solutions in some way, but aren't optimal
2017

2118
## Features
2219

2320
- Optionally configurationless
2421
- Can install any language with pure Bash
25-
- Clean Bash code (uses builtins and Bash facilities over external utilities)
22+
- Clean Bash code (heavily favors builtins and Bash facilities over external utilities)
2623

27-
## Use Cases
24+
## Preview (v0.2.0)
2825

29-
- Different projects that use $language have different version requirements
30-
- Performance testing
31-
- Rootless installations
26+
[![asciicast](https://asciinema.org/a/485308.svg)](https://asciinema.org/a/485308)
3227

3328
## Current Support
3429

35-
Woof plans to support many tens of languages. Currently, there is limited support for NodeJS, Deno, Go, Crystal, Nim, Dart, and the Hashicorp suite of tools. See the full list in [roadmap](./docs/roadmap.md). Furthermore, the following platforms are supported
36-
37-
- Linux (later Darwin, FreeBSD)
38-
- amd64 (later x86, armv7l, aarch64)
39-
- Bash (later Zsh, Ksh, Fish, etc.)
30+
Woof already supports 10 languages on `x86_64`. For more details, see the [roadmap](./docs/roadmap.md)
4031

4132
We attempt to be reasonably compatible with all existing tools. For example, it will read asdf's [.tool-versions](https://asdf-vm.com/manage/configuration.html#tool-versions), nvm's [.nvmrc](https://github.com/nvm-sh/nvm#nvmrc) and read things from popular version managers like `rvm` and `pyenv`
4233

docs/roadmap.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ There are three levels of support:
88
- Dogfooding (it works on my machine)
99
- Complete (works everywhere with supporting test suite)
1010

11+
## Shells
12+
13+
Support shells
14+
15+
- Bash (WIP)
16+
- Zsh, Ksh, Fish, Elvish, Oil
17+
1118
## Buildless Programming Languages
1219

1320
| Language | Current Support | Official Download | Replaces |

0 commit comments

Comments
 (0)