Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Commit

Permalink
README: updated with a word of warning
Browse files Browse the repository at this point in the history
  • Loading branch information
László Vaskó committed Oct 23, 2019
1 parent c732353 commit 6182914
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# nix-straight.el

Low-level integration to [straight.el](https://github.com/raxod502/straight.el)
Low-level Nix integration to [straight.el](https://github.com/raxod502/straight.el)

See [nix-doom-emacs](https://github.com/vlaci/nix-doom-emacs) for a usage example.

There are a couple of issues you may need to be aware of:
* Packageges which are cannot be located are (somewhat) silently ignored, only a
trace message appears during build.
* Package names are dumbly inferred using the `meta.homepage` and `ename`
attributes. If they are both present and not match, then the packages is
instaled under both names in the `repos` directory.
* Packages are symlinked from the store so all VCS related operations are
unavailable and package contents may differ from the ones would be installed
from e.g. MELPA.
* Recipe targets are totally ignored, so there is currently no way of knowing if
a derivation from melpa would be used instead of a fork for example. However I
am planning to add a tool to generate Nix expressions from straight recipes in
the future.

0 comments on commit 6182914

Please sign in to comment.