Skip to content

Commit b3f9c95

Browse files
committed
docs: update intro
1 parent c4b7a5c commit b3f9c95

File tree

4 files changed

+24
-22
lines changed

4 files changed

+24
-22
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ and switch between different environment you need via the command line.
2020

2121
## Why use vfox?
2222

23-
- **cross-platform support** (Windows, Linux, macOS)
23+
- **cross-platform support** (**Windows**, Linux, macOS)
2424
- **consistent commands** to manage all your languages
25-
- support **Global****Project****Session** scopes when switching versions
26-
- simple **plugin system** to add support for your language of choice
25+
- supports **different versions for different projects, different shells, and globally**.
26+
- simple **plugin system** to add support for your runtime of choice
2727
- **automatically switches** runtime versions as you traverse your project
28-
- shell completion available for common shells (Bash, ZSH, Powershell, Clink)
2928
- support for existing config files `.node-version`, `.nvmrc`, `.sdkmanrc` for easy migration
29+
- shell completion available for common shells (Bash, ZSH, Powershell, Clink)
3030
- **it's faster than `asdf-vm`, and offers more simple commands and genuine cross-platform unification.**
3131
see [Comparison with asdf](https://vfox.lhan.me/misc/vs-asdf.html)
3232

@@ -40,7 +40,7 @@ and switch between different environment you need via the command line.
4040
4141
#### 1. Choose an [installation](https://vfox.lhan.me/guides/quick-start.html#_1-installation) that works for you.
4242

43-
#### 2. ⚠️ **_Hook vfox into your shell_ (pick one that works for your shell)** ⚠️
43+
#### 2. ⚠️ **_Hook `vfox` into your shell_ (pick one that works for your shell)** ⚠️
4444

4545
```bash
4646
echo 'eval "$(vfox activate bash)"' >> ~/.bashrc

README_CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
## 为什么选择 vfox?
2020

2121
- 支持**Windows(非WSL)**、Linux、macOS!
22-
- 支持**Global****Project****Session** 三种作用域
22+
- 支持**不同项目不同版本****不同Shell不同版本**以及**全局版本**
2323
- 简单的 **插件系统** 来添加对你选择的语言的支持
2424
- 在您切换项目时, 帮您**自动切换**运行时版本
25-
- 支持常用Shell(Powershell、Bash、ZSH),并提供补全功能
2625
- 支持现有配置文件 `.node-version``.nvmrc``.sdkmanrc`,以方便迁移
26+
- 支持常用Shell(Powershell、Bash、ZSH),并提供补全功能
2727
- **`asdf-vm` 更快**,并提供更简单的命令和真正的跨平台统一。参见 [与asdf-vm对比](https://vfox.lhan.me/zh-hans/misc/vs-asdf.html)
2828

2929
## 演示

docs/guides/intro.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ through a simple plugin interface.
1616

1717
## Why use vfox?
1818

19-
- **Cross-platform** Supports Windows (non-WSL), Linux, macOS!
20-
- **Consistent commands** for managing all your languages
21-
- Supports **Global**, **Project**, **Session** three scopes
22-
- Simple **plugin system** to add support for the languages you choose
23-
- **Automatically switch** runtime versions for you when you switch projects
24-
- Supports common Shells (Powershell, Bash, ZSH), and provides autocompletion
19+
- **cross-platform support** (**Windows**, Linux, macOS)
20+
- **consistent commands** to manage all your languages
21+
- supports **different versions for different projects, different shells, and globally**.
22+
- simple **plugin system** to add support for your runtime of choice
23+
- **automatically switches** runtime versions as you traverse your project
24+
- support for existing config files `.node-version`, `.nvmrc`, `.sdkmanrc` for easy migration
25+
- shell completion available for common shells (Bash, ZSH, Powershell, Clink)
2526
- **Faster than `asdf-vm`**, and provides simpler commands and true cross-platform unification.
2627
See [Comparison to asdf](../misc/vs-asdf.md)
2728

@@ -34,7 +35,7 @@ through a simple plugin interface.
3435
| Bash || |
3536
| ZSH || |
3637
| Fish || |
37-
| CMD || Only Support `Global` Scope |
38+
| CMD || Only Support `Global` Scope. Not Recommend!!! |
3839
| Clink || |
3940
| Cmder || |
4041

@@ -50,6 +51,6 @@ through a simple plugin interface.
5051

5152
![pluigns](https://contrib.rocks/image?repo=version-fox/vfox)
5253

53-
#### [vfox-plugins](https://github.com/version-fox/version-fox-plugins)
54+
#### [Public Registry](https://github.com/version-fox/vfox-plugins)
5455

55-
![pluigns](https://contrib.rocks/image?repo=version-fox/version-fox-plugins)
56+
![pluigns](https://contrib.rocks/image?repo=version-fox/vfox-plugins))

docs/zh-hans/guides/intro.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
如果你经常需要在各种开发项目之间切换,而这些项目又各自需要不同的运行环境,尤其是不同的运行时版本或环境库, 或者
44
厌倦了各种环境繁琐的配置,那么 `vfox` 就是你的不二选择。
55

6-
`vfox` 是一款跨平台、可拓展的通用版本管理器。支持**原生Windows**, 当然**Unix-like**也一定支持! 通过它,您可以**快速安装和切换**开发环境。
6+
`vfox` 是一款跨平台、可拓展的通用版本管理器。支持**原生Windows**以及**Unix-like**! 通过它,您可以**快速安装和切换**开发环境。
77

88
它将所有的工具版本信息保存在一个名为 `.tool-versions` 的文件中,这样您就可以在项目中共享这些信息,确保团队中的每个人都使用相同的工具版本。
99

@@ -13,11 +13,12 @@ API、配置文件和实现方式(比如,`$PATH`
1313

1414
## 为什么选择 vfox?
1515

16+
1617
- 支持**Windows(非WSL)**、Linux、macOS!
17-
- **一致的命令** 用于管理你所有的语言
18-
- 支持**Global****Project****Session** 三种作用域
18+
- 支持**不同项目不同版本****不同Shell不同版本**以及**全局版本**
1919
- 简单的 **插件系统** 来添加对你选择的语言的支持
2020
- 在您切换项目时, 帮您**自动切换**运行时版本
21+
- 支持现有配置文件 `.node-version``.nvmrc``.sdkmanrc`,以方便迁移
2122
- 支持常用Shell(Powershell、Bash、ZSH),并提供补全功能
2223
- **`asdf-vm` 更快**,并提供更简单的命令和真正的跨平台统一。参见 [与asdf-vm对比](../misc/vs-asdf.md)
2324

@@ -30,7 +31,7 @@ API、配置文件和实现方式(比如,`$PATH`
3031
| Bash || |
3132
| ZSH || |
3233
| Fish || |
33-
| CMD || 仅支持`Global`作用域 |
34+
| CMD || 仅支持`Global`作用域,不推荐使用!!! |
3435
| Clink || |
3536
| Cmder || |
3637

@@ -45,6 +46,6 @@ API、配置文件和实现方式(比如,`$PATH`
4546

4647
![pluigns](https://contrib.rocks/image?repo=version-fox/vfox)
4748

48-
#### [插件仓库](https://github.com/version-fox/version-fox-plugins)
49+
#### [插件仓库](https://github.com/version-fox/vfox-plugins)
4950

50-
![pluigns](https://contrib.rocks/image?repo=version-fox/version-fox-plugins)
51+
![pluigns](https://contrib.rocks/image?repo=version-fox/vfox-plugins))

0 commit comments

Comments
 (0)