[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/nix-mode 58325164ca 232/500: Update README.md
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/nix-mode 58325164ca 232/500: Update README.md |
Date: |
Sat, 29 Jan 2022 08:27:09 -0500 (EST) |
branch: elpa/nix-mode
commit 58325164ca063e5f603fb4e097bfa448c76387b5
Author: Matthew Bauer <matthew.bauer@obsidian.systems>
Commit: Matthew Bauer <matthew.bauer@obsidian.systems>
Update README.md
---
README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+)
diff --git a/README.md b/README.md
index ff0b79b2c7..f6cb67d6be 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,64 @@
An emacs major mode for editing nix expressions.
+## Recommended config
+
+```
+(use-package nix
+ :ensure nix-mode
+ :commands global-nix-mode
+ :init (global-nix-mode))
+```
+
+## Submodes
+
+A quick list of what is provided.
+
+### nix.el
+
+nix.el contains some miscellaneous tools for Nix developers.
+Interactive functions include:
+
+- nix-unpack - unpack source of a Nix attribute.
+
+ To use this just type:
+
+ M-x nix-unpack<RET>
+
+ Followed by your Nix path & attribute path.
+
+- nix-build - build a Nix derviation.
+
+ This is meant to work similarly to M-x compile. It will use your
+ current directory & build it if there is a default.nix there.
+
+nix.el also provides some basic functions for interfacing with Nix.
+Some variables are provided to point to the Nix binaries that can be
+used in Lisp code:
+
+- nix-executable
+- nix-build-executable
+- nix-instantiate-executable
+- nix-store-executable
+- nix-shell-executable
+
+Other useful functions for Lisp scripts are provided:
+
+- nix-system - Get the current system, detected by Nix
+
+### nix-repl.el
+
+nix-repl.el has two purposes.
+
+First, it provides an interface for completion, used by nix-company.el.
+
+Second, it provides an interactive function to open an repl. You can
+open this with:
+
+M-x nix-repl<RET>
+
+## Origins
+
This repository is based off of the nix-mode.el file originally located in
the [Nix repository](https://github.com/NixOS/nix)
at
- [nongnu] elpa/nix-mode 2def0ccd6a 191/500: Add autoload for company-nix command, (continued)
- [nongnu] elpa/nix-mode 2def0ccd6a 191/500: Add autoload for company-nix command, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 895f9d14e5 193/500: Flatten "unless" form with no body, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 4a5b6d5d2c 177/500: Add travis and Makefile, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode af35742d55 198/500: Merge pull request #39 from purcell/master, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 1b3424ade0 190/500: Don't ignore errors when loading nix-format / nix-shebang, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 93a59d9acb 179/500: Use cl-lib instead of cl., ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 7c732faf3a 183/500: Handle smartparens in nix-mode., ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 7716e6d1e4 208/500: fix (cond) usage, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 236318101e 217/500: Cleanup global-nix-mode, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 857d963d1e 219/500: Add nix-system function, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 58325164ca 232/500: Update README.md,
ELPA Syncer <=
- [nongnu] elpa/nix-mode 36070654c8 243/500: Don’t autoload nix-instantiate., ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode d2f4a629a8 258/500: Only show derivations in nix store, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode d0eb92e97a 263/500: Package linting, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 38061187ca 265/500: Add nix-read-file & nix-read-attr, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 7d65288c72 266/500: Fix erroneous use of function as variable, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 8b3a9927e7 270/500: Add dependency on json-mode, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 7a7f600133 288/500: travis: Add travis badge, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode da16900326 293/500: tests: Add a testcase with broken identation to have as a check if it indents at all, ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode aa43b72a45 014/500: Revert "Use warning font lock for upper case vars", ELPA Syncer, 2022/01/29
- [nongnu] elpa/nix-mode 5a2674592f 033/500: Don't save-excursion for nix-indent-line., ELPA Syncer, 2022/01/29