Skip to content

jsalzbergedu/etoile-emacs

Repository files navigation

Etoile – An emacs config using the straight package manager

Goals

The goals of this config are to

  1. Use the straight package manager to manage packages, including cloning and building repositories.
  2. Break up my emacs config into reusable parts
  3. Be usable from any linux computer without hassle.

System Requirements

  1. Inconsolata LGC font
  2. Fira Mono font
  3. ccls language server

Guidelines

  1. Use use-package for every package loaded
  2. Every package can be fetched from github (or another source defined by straight) that is to say, :straight should not be nil for any package except ones that are part of emacs.
  3. If the configuration of a package takes more than ten lines, add an auxilary package called +[package_name] that contains the configuration
  4. :defer when possible, :demand otherwise (but never leave that unspecified)

Reminders

  1. Edit ~/.emacs.d/straight/build/etoile/ and not the ~/.emacs.d/ itself!

Installation:

Make sure you have no ~/.emacs file:

mv ~/.emacs ~/.emacs.backup

Stow away your .emacs.d

mv ~/.emacs.d ~/.emacs.d.old

Clone this repository

cd ~/
git clone https://github.com/jsalzbergedu/etoile-emacs.git

Finally, to install:

mkdir ~/.emacs.d
ln -s $HOME/etoile-emacs/init.el $HOME/.emacs.d/init.el
emacs

(It should take quite a bit of time to install.)

About

A modular emacs config based on the straight package manager

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published