awesome-emacs/nix-doom-emacs
1
0
Fork 0
mirror of https://github.com/nix-community/nix-doom-emacs synced 2025-08-11 13:07:28 -05:00
Code Issues Packages Projects Releases Wiki Activity

README.md: Reformat and fix spelling

Browse Source
This commit is contained in:
László Vaskó
2021-01-23 17:29:31 +01:00
parent 30eee51235
commit 327b4629ed
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -12,7 +12,7 @@ Nix expression to install and configure
The expression builds a `doom-emacs` distribution with dependencies The expression builds a `doom-emacs` distribution with dependencies
pre-installed based on an existing `~/.doom.d` directory. pre-installed based on an existing `~/.doom.d` directory.
It is not a fully fledged exprerience as some dependenices are not installed and 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 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 [emacs-overlay](https://github.com/nix-community/emacs-overlay) may not be
compatible with the `doom-emacs` requirements. compatible with the `doom-emacs` requirements.
@ -39,6 +39,10 @@ in {
} }
``` ```
`./doom.d` should contain the following three files: `config.el`, `init.el` and
`packages.el`. If you don't already have an existing `doom-emacs` configuration,
you can use the contents of `test/doom.d` as a template.
Using `flake.nix`: Using `flake.nix`:
``` nix ``` nix
@ -78,7 +82,7 @@ Using `flake.nix`:
This expression leverages This expression leverages
[nix-straight.el](https://github.com/vlaci/nix-straight.el) under the hood for [nix-straight.el](https://github.com/vlaci/nix-straight.el) under the hood for
installing depdendencies. The restrictions of that package apply here too. installing dependencies. The restrictions of that package apply here too.
## Usage ## Usage
@ -90,13 +94,15 @@ On macOS on a fresh install, you might run into the error `Too many files open`.
## Installing emacs packages ## Installing emacs packages
In the initial packages.el instructions for how to install packages can be found. In the initial packages.el instructions for how to install packages can be
However some packages might require a particular software dependency to be installed. found. However some packages might require a particular software dependency to
Trying to install those would give you an error of the type: be installed. Trying to install those would give you an error of the type:
`Searching for program: No such file or directory, git` (Missing git dependency) `Searching for program: No such file or directory, git` (Missing git dependency)
Here is how you would go installing [magit-delta](https://github.com/dandavison/magit-delta) for example (which requires git). Here is how you would go installing
[magit-delta](https://github.com/dandavison/magit-delta) for example (which
requires git).
under the line: Under the line:
`doomPrivateDir = ./doom.d;` `doomPrivateDir = ./doom.d;`
in your configuration, you would add the following: in your configuration, you would add the following:
@ -107,12 +113,15 @@ in your configuration, you would add the following:
}); });
}; };
``` ```
to make the git dependency available.
trying to rebuild doom-emacs with `home-manager switch` should work correctly now. To make the git dependency available. trying to rebuild doom-emacs with
`home-manager switch` should work correctly now.
## Using the daemon ## Using the daemon
to use the daemon, simply enable the emacs service (with nixos, home-manager or nix-darwin) and use the doom emacs package. `doom-emacs` will need to be referenced at the top of your config file. To use the daemon, simply enable the emacs service (with `NixOS`, `home-manager`
or `nix-darwin`) and use the doom emacs package. `doom-emacs` will need to be
referenced at the top of your config file.
```nix ```nix
services.emacs = { services.emacs = {