Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.6 KB

README.md

File metadata and controls

48 lines (34 loc) · 2.6 KB
index
readme reference faq

nix-doom-emacs

Status
Build on master Build Status on master
Dependency updater Dependency Updater Status
Matrix Chat Matrix Chat

nix-doom-emacs (abbreviated as NDE) provides a customisable Nix derivation for Doom Emacs.

⚠ Broken

This project has been broken for more than a year due to Doom's excessive divergence from emacs-overlay's package set, which is not Doom's fault but rather a missing Elisp package locking mechanism on our end. (Update PR, Tracking issue)


The expression builds a doom-emacs distribution with dependencies pre-installed based on an existing ~/.doom.d directory.

It is not a fully fledged experience as some dependencies are not installed and some may not be fully compatible as the version available in NixOS or emacs-overlay may not be compatible with the doom-emacs requirements.

Quick Start

If you want to get a taste of nix-doom-emacs, you can run nix run github:nix-community/nix-doom-emacs Which will run nix-doom-emacs with an example configuration.

Pick which setup you're using here (if you're not using NixOS or Home-Manager, then you should use standalone):

Home-Manager NixOS Standalone
Flake + Home-Manager NixOS Standalone

Hacking

This project is under MIT license. Our issue tracker has some open issues, the PR wanted label is for issues that need PRs to fix them. Also, talk to us in the Matrix Chat to discuss ideas for future improvements. Contributions are welcome.