awesome-emacs/nix-doom-emacs
1
0
Fork 0
mirror of https://github.com/nix-community/nix-doom-emacs synced 2025-09-30 17:01:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

resolve reviews

Browse Source
This commit is contained in:
Mon Aaraj
2022-09-21 20:08:03 +03:00
parent 1a524776a4
commit 5952ea8b87
3 changed files with 37 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,6 +1,4 @@
| readme | reference | faq |
| --- | --- | --- |
| this document | [docs/reference.md](./docs/reference.md)| [docs/faq.md](./docs/faq.md) |
| readme | [reference](./docs/reference.md)| [faq](./docs/faq.md) |
# nix-doom-emacs
@@ -10,10 +8,8 @@
| 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 expression to install and configure
[doom-emacs](https://github.com/doomemacs/doomemacs).
nix-doom-emacs (also commonly referred to as NDE in chatrooms) is a project with lots of moving pieces and hacks. Users are expected to know their way around using (and especially debugging) Nix and Emacs Lisp in order to use this project.
nix-doom-emacs (abbreviated as NDE) provides a customisable Nix derivation for [Doom Emacs](https://github.com/doomemacs/doomemacs)
The project has lots of moving pieces and hacks. Users are expected to know their way around using (and especially debugging) Nix and Emacs Lisp in order to use this project.
The expression builds a `doom-emacs` distribution with dependencies
pre-installed based on an existing `~/.doom.d` directory.
@@ -33,3 +29,10 @@ Pick which setup you're using here (if you're not using NixOS or Home-Manager, t
| 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 licensend under MIT. Only bugs should be filed in our [issue tracker](https://github.com/nix-community/nix-doom-emacs/issues).
The `PR wanted` label is for issues that we'd appreciate PRs for the most.
Contributions are welcome.