syl20bnr / spacemacs

philosophy 
|
 for whom? 
|
 screenshots 
|
 documentation 
|
 contribute 
|
 achievements 
|
 FAQ 
- - -
**Quick Start**
If you *don't* have an existing Emacs setup and want to run Spacemacs as your
configuration, and if you have all prerequisites installed,
you can install Spacemacs with one line:
* shell:
 [code] 
* Windows PowerShell:
 [code] 
 If `HOME` is not set in environment or in registry:
 [code] 
If you do have an existing Emacs configuration, look at the full installation
instructions for other options.
# Introduction
Spacemacs is a new way of experiencing Emacs -- it's a sophisticated and
polished set-up, focused on *ergonomics*, *mnemonics* and *consistency*.
Just clone and launch it, then press the space bar to explore the interactive
list of carefully-chosen key bindings. You can also press the home buffer's
`[?]` button for some great first key bindings to try.
Spacemacs can be used naturally by both Emacs and Vim users -- you can even mix
the two editing styles. Being able to quickly switch between input styles, makes
Spacemacs a great tool for pair-programming.
Spacemacs is currently in beta, and any contributions are very welcome.
# Features
- **Great documentation:** access the Spacemacs documentation with
 SPC h SPC .
- **Beautiful GUI:** you'll love the distraction free UI and its functional
mode-line.
- **Excellent ergonomics:** all the key bindings are accessible by pressing the
 SPC or Alt-m .
- **Mnemonic key bindings:** commands have mnemonic prefixes like
 SPC b for all the buffer commands or SPC p for the project
commands.
- **Batteries included:** discover hundreds of ready-to-use packages nicely
organized in configuration layers following a set of [conventions
][CONVENTIONS.org].
# Documentation
Comprehensive documentation is available for each layer by pressing SPC h
SPC .
You can also check the [general documentation][DOCUMENTATION.org],
[quick start guide][QUICK_START.org] and the [FAQ][FAQ.org].
# Getting Help
If you need help, ask your questions in the [Gitter Chat][] and a member of the
community will help you out.
If you prefer IRC, connect to the [Gitter Chat IRC server][] and join the
`#syl20bnr/spacemacs` channel.
Last but not least there are a lot of high class tutorials available on YouTube:
* Jack of Some's [Spacemacs tutorial videos][jack-of-some].
* GDQuest's [Game Design oriented tutorials ][gdquest] to Spacemacs.
* Practicalli's [Clojure tutorials based on Spacemacs][practicalli].
* Eivind Fonn's classic [Spacemacs ABC][eivind-fonn].
# Prerequisites
1. A package manager if the OS doesn't have one already.
2. Spacemacs is an extension of a popular text editor called [Emacs][GNU Emacs].
 So you'll need Emacs installed first.
 Spacemacs requires Emacs 28.2 or above. The development version of Emacs is
 not *officially* supported, but it should nevertheless be expected to work.
3. [git][Git] is required to download and update Spacemacs.
4. Tar, in particular [GNU Tar][], is required to install and upd