awesome-emacs/nix-doom-emacs
1
0
Fork 0
mirror of https://github.com/nix-community/nix-doom-emacs synced 2025-09-18 16:06:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Thiago Kenji Okada
2022-10-29 17:43:47 +01:00
parent 5952ea8b87
commit dd63c54651
3 changed files with 24 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,4 +1,4 @@
| readme | [reference](./docs/reference.md)| [faq](./docs/faq.md) |
<table><tr><th>**readme**</th><th>[reference](./docs/reference.md)</th><th>[faq](./docs/faq.md)</th></tr></table>
# nix-doom-emacs
@@ -8,8 +8,7 @@
| 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)
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.
nix-doom-emacs (abbreviated as NDE) provides a customisable Nix derivation for [Doom Emacs](https://github.com/doomemacs/doomemacs).
The expression builds a `doom-emacs` distribution with dependencies
pre-installed based on an existing `~/.doom.d` directory.
@@ -30,9 +29,9 @@ Pick which setup you're using here (if you're not using NixOS or Home-Manager, t
| --- | --- | --- |
| [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.
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.