https://github.com/nix-community/nix-doom-emacs

doom-emacs packaged for Nix [maintainers=@thiagokokada]
https://github.com/nix-community/nix-doom-emacs

Last synced: 3 months ago
JSON representation

doom-emacs packaged for Nix [maintainers=@thiagokokada]

• Host: GitHub
• URL: https://github.com/nix-community/nix-doom-emacs
• Owner: nix-community
• License: mit
• Fork: true (vlaci/nix-doom-emacs)
• Created: 2021-12-10T13:02:03.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-29T13:34:43.000Z (11 months ago)
• Last Synced: 2024-07-22T20:04:58.431Z (3 months ago)
• Language: Nix
• Homepage:
• Size: 1.55 MB
• Stars: 214
• Watchers: 14
• Forks: 43
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
| index |     |     |

| --- | --- | --- |

|**readme**|[reference](./docs/reference.md)|[faq](./docs/faq.md)|

# nix-doom-emacs

|     | Status |

| --- | --- |

| Build on `master` | [![Build Status on master](https://github.com/nix-community/nix-doom-emacs/workflows/Check%20Build/badge.svg?branch=master&event=push)](https://github.com/nix-community/nix-doom-emacs/actions/workflows/check-build.yml?query=branch%3Amaster) |

| Dependency updater | [![Dependency Updater Status](https://github.com/nix-community/nix-doom-emacs/workflows/Update%20Dependencies/badge.svg?branch=master)](https://github.com/nix-community/nix-doom-emacs/actions/workflows/update-dependencies.yml?query=branch%3Amaster) |

| Matrix Chat | [![Matrix Chat](https://img.shields.io/static/v1?label=chat&message=doom-emacs&color=brightgreen&logo=matrix)](https://matrix.to/#/#doom-emacs:nixos.org) |

nix-doom-emacs (abbreviated as NDE) provides a customisable Nix derivation for [Doom Emacs](https://github.com/doomemacs/doomemacs).

## ⚠ 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](https://github.com/nix-community/nix-doom-emacs/pull/316), [Tracking issue](https://github.com/nix-community/nix-doom-emacs/issues/353))

---

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](https://github.com/nix-community/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](./docs/reference.md#home-manager) | [NixOS](./docs/reference.md#nixos) | [Standalone](./docs/reference.md#standalone) |

# Hacking

This project is under MIT license. Our [issue tracker](https://github.com/nix-community/nix-doom-emacs/issues) 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](https://matrix.to/#/#doom-emacs:nixos.org) to discuss ideas for future improvements.

Contributions are welcome.