mirror of
https://github.com/nix-community/nix-doom-emacs
synced 2025-09-02 14:53:40 -05:00
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# nix-doom-emacs
|
|
|
|
| | Status |
|
|
| --- | --- |
|
|
| Build on `master` | [](https://github.com/nix-community/nix-doom-emacs/actions/workflows/check-build.yml?query=branch%3Amaster) |
|
|
| Dependency updater | [](https://github.com/nix-community/nix-doom-emacs/actions/workflows/update-dependencies.yml?query=branch%3Amaster) |
|
|
| Matrix Chat | [](https://matrix.to/#/#doom-emacs:nixos.org) |
|
|
|
|
Nix expression to install and configure
|
|
[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.
|
|
|
|
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.
|
|
Continue to [the documentation](./docs) to learn how to customise your setup further to your needs.
|
|
|
|
|
|
# Documentation
|
|
To know how to use nix-doom-emacs, and to fix other issues, check the [documentation](./docs)
|