TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve quick-start guide 

The [quick-start](https://www.spacemacs.org/doc/QUICK_START.html) starts with
 explaining that users can build their own layers. Instead it should start by
 showing how easy and straightforward it is to use one of the existing layer,
 then continue about the possibility of creating personal layers (the
 quick-start guide is a logical place to visit first for a newcomer). It is only
 a small detail, but it can make a substantial difference for people who peek
 into the quick-start guide and decide if it is worth the trouble to switch to
 Spacemacs (Many newcomers think that even only trying another editor, is
 probably not worth it because they are already using vim).

A guide that starts explaininging that you can build your own layers in
Spacemacs that exists of a directory containing at a packages.el file, is not a
quick-start guide.
This commit is contained in:
Daniel Nicolai 2021-04-26 10:01:09 +02:00 committed by Maximilian Wolff
parent 29fa26af98
commit 4f8ac8fc39
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/QUICK_START.org
View File

@ -16,11 +16,28 @@
* Configuration layers
Spacemacs divides its configuration into self-contained units called
=configuration layers=. These layers are stacked on top of each other
to achieve a custom configuration.
=configuration layers=. These layers are stacked on top of each other to achieve
a custom configuration.
By default Spacemacs uses a dotfile called =~/.spacemacs= to control which
layers to load. Within this file you can also configure certain features.
layers to load. Within this file you can also configure certain features. This
design makes it extremely easy to turn Spacemacs into a fully integrated
development environment.
For example to get python support, simply add =python= to the list of
=dotspacemacs-configuration-layers= in your =~/.spacemacs=. Find the
=~/.spacemacs= file by pressing =SPC f e d= and then after adding the layer,
reload it with =SPC f e R=. Now open a =.py= file (=SPC f f=) to find the python
environment has been fully configured. Some extra configuration might make the
environment even more powerful, which is very well described in the [[https://develop.spacemacs.org/layers/+lang/python/README.html][layer's
documentation]] that can be accessed by pressing =SPC h l= and selecting the
=python= layer entry. For configuration of specific packages within a layer,
=SPC h SPC= provides quick navigation functionality for jumping directly to the
relevant location within the configuration files.
A list of pre-configured layers is available [[https://develop.spacemacs.org/layers/LAYERS.html][here]]. If you still would like to
configure anything not covered by any layer, then it is easy to build a personal
layer.
A configuration layer is a directory containing at least a =packages.el=
file which defines and configures packages to be downloaded from Emacs