1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 09:30:04 +08:00
SpaceVim/docs/index.md

57 lines
2.4 KiB
Markdown
Raw Normal View History

2017-02-15 22:05:31 +08:00
---
title: "Home"
---
2017-02-10 00:41:23 +08:00
# Introduction
2017-02-08 23:09:16 +08:00
2017-02-06 21:38:14 +08:00
[![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim)
2017-02-20 22:05:01 +08:00
![Version 0.2.0-dev](https://img.shields.io/badge/version-0.2.0--dev-yellow.svg?style=flat-square)
2017-02-12 19:06:58 +08:00
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/SpaceVim/SpaceVim/dev/LICENSE)
[![Doc](https://img.shields.io/badge/doc-%3Ah%20SpaceVim-orange.svg?style=flat-square)](https://raw.githubusercontent.com/SpaceVim/SpaceVim/dev/doc/SpaceVim.txt)
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a modular configuration for neovim and vim,
here we call all of the modules layers, each layer has different plugins and config, users just need
2017-02-06 21:38:14 +08:00
to select the layers they need. It got inspired by [spacemacs](https://github.com/syl20bnr/spacemacs). If you use SpaceVim,
please star it on github. It's a great way of getting feedback and gives me the kick to
put more time into development.
2017-02-20 22:05:01 +08:00
![2017-02-05_1359x721](https://cloud.githubusercontent.com/assets/13142418/22622826/f88881a8-eb80-11e6-880b-b12e0430689a.png)
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore).
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
## Install
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
### Linux/Mac
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
If you are using linux or mac os, it is recommenced to use this command to install SpaceVim:
2017-02-06 21:38:14 +08:00
```sh
curl -sLf https://spacevim.org/install.sh | bash
```
2017-02-20 22:05:01 +08:00
with this command, SpaceVim will be installed. all the plugins will be install automatically when first time run vim/nvim.
2017-02-06 21:38:14 +08:00
for more info about the install script, please check:
```sh
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
Before you use SpaceVim, you should install the plugin by executing `:call dein#install()` in (neo-)vim.
2017-02-20 22:05:01 +08:00
### windows support
2017-02-06 21:38:14 +08:00
- For vim in windows, please just clone this repo as vimfiles in you Home directory.
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
make sure you have a backup of your own vimfiles.
```sh
git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
```
- For neovim in windows, please clone this repo as `AppData\Local\nvim` in your home directory.
for more info, please check out [neovim's wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim).
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
```sh
git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
```