Skip to content

Commit

Permalink
doc: modify introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
aooohan committed Mar 6, 2024
1 parent ad4820b commit 0a25978
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@

[[English]](./README.md) [[中文文档]](./README_CN.md)

If you switch between development projects which expect different environments, specifically different runtime versions or ambient libraries,
or you are tired of all kinds of cumbersome environment configurations, `vfox` is the ideal choice for you.
## Introduction

**`vfox` is a cross-platform tool for managing SDK versions, extendable via plugins**. It allows you to quickly install
and switch between different versions of SDKs using the command line.
**`vfox` is a cross-platform version manager(similar to `nvm`, `fvm`, `sdkman`, `asdf-vm`, etc.), extendable via plugins**. It allows you to quickly install
and switch between different environment you need via the command line.

## Why use VersionFox?

Expand Down
5 changes: 3 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@

[[English]](./README.md) [[中文文档]](./README_CN.md)

如果你经常需要在**各种开发项目之间切换**,而这些项目又各自**需要不同的运行环境**,尤其是不同的运行时版本或环境库, 或者
**厌倦了各种繁琐的环境配置**,那么 `vfox` 就是你的不二选择。
## 介绍

`vfox` 是一个跨平台的 SDK 版本管理工具,通过插件机制进行拓展。它允许您通过命令行快速安装和切换不同版本的 SDK。

`vfox` 是一个跨平台版本管理器(类似于 `nvm``fvm``sdkman``asdf-vm` 等),可通过插件扩展。它允许您快速安装和切换您需要的环境。
## 为什么选择 vfox?

- 支持**Windows(非WSL)**、Linux、macOS!
Expand Down
5 changes: 4 additions & 1 deletion docs/guides/intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Introduction

If you switch between development projects which expect different environments, specifically different runtime versions or ambient libraries,
or you are tired of all kinds of cumbersome environment configurations, `vfox` is the ideal choice for you.

`vfox` is a cross-platform, extensible version manager. It supports **native Windows**, and of course **Unix-like**!
With it, you can **quickly install and switch** tool versions.
With it, you can **quickly install and switch** different environment.

It saves all tool version information in a file named `.tool-versions`, so you can share this information in your
project to ensure that everyone on your team is using the same tool versions.
Expand Down
13 changes: 7 additions & 6 deletions docs/zh-hans/guides/intro.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# 项目简介

`vfox` 是一款跨平台、可拓展的通用版本管理器。支持**原生Windows**, 当然**Unix-like**也一定支持! 通过它,您可以**快速安装和切换**工具版本。
如果你经常需要在各种开发项目之间切换,而这些项目又各自需要不同的运行环境,尤其是不同的运行时版本或环境库, 或者
厌倦了各种环境繁琐的配置,那么 `vfox` 就是你的不二选择。

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

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

传统工作方式需要多个命令行版本管理器,而且每个管理器都有其不同的 API、配置文件和实现方式(比如,`$PATH`
传统工作方式需要多个命令行版本管理器(如`nvm``fvm``sdkman``asdf-vm`等),而且每个管理器都有其不同的
API、配置文件和实现方式(比如,`$PATH`
操作、垫片、环境变量等等)。`vfox` 提供单个交互方式和配置文件来简化开发工作流程,并可通过简单的插件接口扩展到所有工具和运行环境。


## 为什么选择 vfox?

- 支持**Windows(非WSL)**、Linux、macOS!
Expand All @@ -18,18 +22,15 @@
- 支持常用Shell(Powershell、bash、zsh),并提供补全功能
- **`asdf-vm` 更快**,并提供更简单的命令和真正的跨平台统一。参见 [与asdf-vm对比](../misc/vs-asdf.md)


## 贡献者

> [!TIP]
> 感谢以下贡献者对本项目的贡献。🎉🎉🙏🙏
#### [核心仓库](https://github.com/version-fox/vfox)


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

#### [插件仓库](https://github.com/version-fox/version-fox-plugins)


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

0 comments on commit 0a25978

Please sign in to comment.