emacs-config/README.org

33 lines
2.2 KiB
Org Mode

#+title: Doom Emacs Configuration --- [[https://tecosaur.github.io/emacs-config/config.html][HTML Version]], [[https://tecosaur.github.io/emacs-config/config.pdf][PDF]]
#+author: tecosaur
#+html: <a href="https://www.gnu.org/software/emacs/emacs.html#Releases"><img src="https://img.shields.io/badge/Emacs-27.1-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white"></a>
#+html: <a href="https://github.com/tecosaur/emacs-config/actions"><img src="https://img.shields.io/github/workflow/status/tecosaur/emacs-config/Publish/master.svg?style=flat-square&label=publish&logo=buffer"></a>
#+html: <a href="https://raw.githubusercontent.com/tecosaur/emacs-config/gh-pages/misc/upgradable-packages.txt"><img src="https://raw.githubusercontent.com/tecosaur/emacs-config/gh-pages/misc/pkg-status.svg"></a>
Here you may find my config. There is only one significant file:
- [[file:config.org][config.org]], my configuration file
What you *really* want is the =M-x org-html-export-to-html= version of ~config.org~ ,
or the =M-x org-latex-export-to-pdf= version (linked in the title).
In addition to the =html= export, this /produces/ the [[https://tecosaur.github.io/emacs-config/init.el.html][init.el]], [[https://tecosaur.github.io/emacs-config/config.el.html][config.el]], and [[https://tecosaur.github.io/emacs-config/packages.el.html][packages.el]] files.
Other than that, snippets are (currently) sourced from the [[file:snippets/][snippets]] folder,
resources are put in [[file:misc/][misc]], and you may find submodules for packages of mine in
[[file:lisp/][lisp]], along with extra major modes.
* Installation
This is mostly a personal note, see the [[https://tecosaur.github.io/emacs-config/config.html#notes-unwary-adventurer][warning]] in my config.
In order to have Doom load the config, we need to initialise the submodules, and
generate the =init.el= once.
#+begin_src shell :eval query
git clone --recurse-submodules git@github.com:tecosaur/emacs-config.git ~/.config/doom
emacs --batch --eval "(require 'org)" --eval '(org-babel-tangle-file "~/.config/doom/config.org")'
git clone --depth 1 https://github.com/hlissner/doom-emacs ~/.emacs.d
~/.emacs.d/bin/doom install; ~/.config/doom/setup.sh
#+end_src