mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-02 20:30:05 +08:00
docs(readme): remove project layout
This commit is contained in:
parent
7da557c1f8
commit
9fba121ed7
@ -1,38 +0,0 @@
|
||||
<!-- Copyright (c) 2016-2023 Wang Shidong & Contributors -->
|
||||
<!-- Author: Wang Shidong < wsdjeg@outlook.com > -->
|
||||
<!-- URL: https://spacevim.org -->
|
||||
<!-- License: GPLv3 -->
|
||||
|
||||
## 贡献代码
|
||||
|
||||
SpaceVim 这一项目的存在,得益于所有参与贡献的朋友,我们非常感谢来自于社区的贡献。
|
||||
为了能够更好的维护 SpaceVim,我们制定了如下规则,要求所有参与的开发者共同遵守。
|
||||
|
||||
### 贡献代码
|
||||
|
||||
我们非常欢迎开发者贡献代码,请仔细阅读以下内容。同时也可以加入我们的[中文聊天室](https://app.element.io/#/room/#spacevim-cn:matrix.org),
|
||||
沟通交流。
|
||||
|
||||
|
||||
#### 开源协议
|
||||
|
||||
SpaceVim 的所有部分均遵循 GPLv3 协议. 这包括:
|
||||
|
||||
- 初始化和核心文件.
|
||||
- 所有 layer 文件.
|
||||
- 文档.
|
||||
|
||||
对于不属于 SpaceVim 的文件, 例如本地包和库, 请参考头文件.
|
||||
这些文件的头部不应为空, 若没有一个合适的头文件, 我们可能不会接受代码.
|
||||
|
||||
#### 约定
|
||||
|
||||
SpaceVim 基于约定, 主要用于函数命名, 按键绑定定义和书写文档..
|
||||
请在第一次贡献前阅读 [约定](https://spacevim.org/cn/conventions/) 来了解它们.
|
||||
|
||||
#### 拉取请求
|
||||
|
||||
提交你的贡献到 `master` 分支. 你不应该使用自己的 `master` 分支来修改 SpaceVim,
|
||||
这个分支是默认只读的.
|
||||
|
||||
你可能需要阅读我们的 [开发者文档](https://spacevim.org/cn/development/).
|
@ -1,33 +0,0 @@
|
||||
<!-- Copyright (c) 2016-2023 Wang Shidong & Contributors -->
|
||||
<!-- Author: Wang Shidong < wsdjeg@outlook.com > -->
|
||||
<!-- URL: https://spacevim.org -->
|
||||
<!-- License: GPLv3 -->
|
||||
|
||||
# Contributing to SpaceVim
|
||||
|
||||
SpaceVim is a project exist thanks to all the people who contribute,
|
||||
we are thankful for all the contributions from community.
|
||||
We have a few guidelines, which we ask all contributors to follow.
|
||||
|
||||
## Asking for help
|
||||
|
||||
If you want to ask an usage question, be sure to look first into these place where maybe hold the answer.
|
||||
|
||||
- [FAQ](https://spacevim.org/faq/): the frequently asked questions about SpaceVim.
|
||||
- [Documentation](spacevim.org/documentation/): the general documentation of SpaceVim.
|
||||
|
||||
In any case, feel free to join us on the [matrix room](https://app.element.io/#/room/#spacevim:matrix.org)
|
||||
to ask questions about contributing.
|
||||
|
||||
## Pull Request
|
||||
|
||||
Submit your contribution against the `master` branch. You should not use your master branch
|
||||
to modify SpaceVim, this branch is considered to be read-only.
|
||||
|
||||
## License
|
||||
|
||||
The license is GPLv3 for all the parts of SpaceVim. this includes:
|
||||
|
||||
- The initialization and core files.
|
||||
- All the layer files.
|
||||
- The documentation
|
26
README.md
26
README.md
@ -5,6 +5,7 @@
|
||||
</h1>
|
||||
|
||||
[Quick Start Guide](https://spacevim.org/quick-start-guide/) \|
|
||||
[FAQ](https://spacevim.org/faq/) \|
|
||||
[Chat](https://app.element.io/#/room/#spacevim:matrix.org) \|
|
||||
[Twitter](https://twitter.com/SpaceVim)
|
||||
|
||||
@ -32,32 +33,9 @@ SpaceVim is a vim configuration inspired by spacemacs, it is compatible with Vim
|
||||
|
||||
[![welcome page](https://img.spacevim.org/release-v2.2.0.png)](https://github.com/SpaceVim/SpaceVim#screenshots)
|
||||
|
||||
## Project Layout
|
||||
|
||||
```txt
|
||||
├─ .ci/ build automation
|
||||
├─ .github/ issue/PR templates
|
||||
├─ .SpaceVim.d/ project specific configuration
|
||||
├─ after/ overrule or add to the distributed defaults
|
||||
├─ autoload/SpaceVim.vim SpaceVim core file
|
||||
├─ autoload/SpaceVim/api/ Public APIs
|
||||
├─ autoload/SpaceVim/layers/ available layers
|
||||
├─ autoload/SpaceVim/plugins/ builtin plugins
|
||||
├─ autoload/SpaceVim/mapping/ mapping guide
|
||||
├─ colors/ default colorscheme
|
||||
├─ docker/ docker image generator
|
||||
├─ bundle/ bundle plugins
|
||||
├─ lua/spacevim/plugin builtin plugins(lua)
|
||||
├─ doc/ help(cn/en)
|
||||
├─ docs/ website(cn/en)
|
||||
├─ wiki/ wiki(cn/en)
|
||||
├─ bin/ executable
|
||||
└─ test/ tests
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
This project wouldn't exist without all the people who [contributed](CONTRIBUTING.md),
|
||||
This project wouldn't exist without all the people who contributed,
|
||||
We are thankful for any contributions from the community.
|
||||
|
||||
<a href="https://github.com/SpaceVim/SpaceVim/graphs/contributors"><img src="https://opencollective.com/spacevim/contributors.svg?width=890&button=false" /></a>
|
||||
|
Loading…
Reference in New Issue
Block a user