Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
archibate committed Apr 2, 2022
1 parent 2e80d5e commit c0a0028
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
10 changes: 6 additions & 4 deletions README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

# Quick Install

Download `vimrc-release.tar.gz` from [GitHub release](github.com/archibate/vimrc/releases).
Download `vimrc-release.tar.gz` from [GitHub release](https://github.com/archibate/vimrc/releases).

Extract it, then execute the `.vim/install.sh` in it.
For speed, Chinese users may download using the [Gitee mirror](https://gitee.com/archibate/vimrc/releases).

Extract it, then execute the script `.vim/install.sh` in it.

It will take some time to detect your Linux distro and install required packages for you:

Expand All @@ -23,8 +25,8 @@ Current supported Linux distros are:

## Contribute

If you know how to install these packages on your distro, please feel free to contribute by
modifying the [release/install.sh](release/install.sh) in this repository.
If you know how to install these packages on your Linux distro (or MacOS / Windows), please feel
free to contribute by modifying the [release/install.sh](release/install.sh) in this repository.

# Manual Install

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

## 一键安装

[GitHub release](github.com/archibate/vimrc/releases) 下载 `vimrc-release.tar.gz`
[GitHub release](https://github.com/archibate/vimrc/releases) 下载 `vimrc-release.tar.gz`

解压并运行其中的 `.vim/install.sh`
为了提升速度,国内用户也可以从 [Gitee 的镜像](https://gitee.com/archibate/vimrc/releases) 下载。

解压并运行其中的 `.vim/install.sh` 这个脚本。

他会花一些时间检测你的 Linux 发行版,并安装下列这些部分插件所需的包:

Expand All @@ -23,12 +25,12 @@

## 手动安装

手动安装方法见 [.vimrc](.vimrc) 中的注释.
手动安装方法见 [.vimrc](.vimrc) 中的注释

## Contribute

如果你知道如何在你的发行版上安装这些包,你可以通过修改这个仓库中的
[release/install.sh](release/install.sh) 来贡献你的力量,并通过 PR 提交更改给我们。
如果你知道如何在你的 Linux 发行版上安装这些包(或者你是 MacOS、Windows),你可以通过修改这个仓库
中的 [release/install.sh](release/install.sh) 来贡献你的力量,并通过 PR 提交更改给我们。

要测试的话,先运行 [release/package.sh](release/package.sh) 来生成 `vimrc-release.tar.gz`
然后用 Docker 等工具在相应的隔离环境中测试是否能正确安装。
Expand Down

0 comments on commit c0a0028

Please sign in to comment.