Skip to content

cy20lin/.spacemacs.d

Repository files navigation

Wow, Spacemacs !?

My Spacemacs configs.

./doc/img/screenshot-spacemacs-exwm-3.png

Prerequisites

This configuration is used under following environment:

Ubuntu 16.04
Windows MSYS2 MinGW64 Shell
not maintained, may break

It depends on develop version of emacs and spacemacs:

emacs
27.0.5
spacemacs
0.300.0

Get Started

Download Spacemacs configuration files.

git clone https://github.com/cy20lin/.spacemacs.d ~/.spacemacs.d
cd ~/.spacemacs.d

Download and install Archer.

Archer is the environment setup script manager used in this configuration. With the help of Archer, one could install the dependencies and set up the environment easily.

git clone https://github.com/cy20lin/archer ~/archer
cd ~/archer
git checkout c0f057822138cebfc28e41108d9779372edc99ca
sudo ./install.sh

Install all dependencies for this configuration.

cd ~/.spacemacs.d
archer install .

Directory structure

+ .spacemacs.d
  + layers/
    + my-<layer>/
  + configs/
    + <config>/
      + init.el
      + config.el
  + doc/
    + img/
      + <image-file>
  + snippets/
  + README.org
  + custom.el
  + init.el

Where:

FileUsage
layers/The place to put private layers
configs/The place to put dotspaemacs configs
snippets/The place to put private snippets for yasnippet
demos/The place to put demo files for this configuration
doc/The place to put document related files
init.elEntry file loaded by spacemacs on startup
custom.elSettings generated by emacs
.spacemacs.envenviroment variables for spacemacs

Configs

Initialation and configuration codes are placed in functions dotspacemacs/user-init and dotspacemacs/user-config.

Though, if the configs are complicate, it is advised to group them into a folder under configs/ directory with initialization codes in init.el and configuration codes in config.el. Then load the codes in the functions dotspacemacs/user-init and dotspacemacs/user-config respectively.

Layers

All private layers are prefixed with my- before its name.

Other Screenshots

./doc/img/screenshot-c++-2.png