1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 13:10:04 +08:00
SpaceVim/docs/quick-start-guide.md
2018-03-14 21:23:52 +08:00

55 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "Quick start guide"
description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature."
---
# Quick start guide
If you havent seen SpaceVim at all yet, the first thing you should read is The Quick start guide.
It will give you a good idea of what SpaceVim is like,
show you how to install it, and explain its features.
Upon completing the book, youll be an intermediate Rust developer, and will have a good grasp of the fundamental ideas behind Rust.
<!-- vim-markdown-toc GFM -->
- [Install](#install)
- [Linux and macOS](#linux-and-macos)
- [Windows](#windows)
- [Learning SpaceVim](#learning-spacevim)
<!-- vim-markdown-toc -->
## Install
At a minimum, SpaceVim requires `git` and `curl` to be installed. These tools
are needed for downloading plugins and fonts.
If you are using vim/neovim in terminal, you also need to set the font of your terminal.
### Linux and macOS
```bash
curl -sLf https://spacevim.org/install.sh | bash
```
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
For more info about the install script, please check:
```bash
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
### Windows
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
## Learning SpaceVim
- [SpaceVim Documentation](documentation). Also known as "The Book", The SpaceVim Documentation will introduce
you to the main topics important to using SpaceVim. The book is the primary official document of the language.
- [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim). Tell you how to hack SpaceVim.