branch: elpa/javelin
commit b543984ec5ba4c9f1d5b09818f07a0a3ee699d03
Author: Damian Barabonkov <[email protected]>
Commit: Damian Barabonkov <[email protected]>
docs: Add development guide for Doom Emacs users
---
DEVELOPMENT.md | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 00000000000..218dd35a852
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,39 @@
+# Development Guide
+
+This guide is for [Doom Emacs](https://github.com/doomemacs/doomemacs) users.
+
+## Local Installation
+
+Add the following to your `packages.el`:
+
+```elisp
+(package! javelin
+ :recipe (:local-repo "/path/to/javelin.el"
+ :build (:not compile)))
+```
+
+Then run `doom sync` to install.
+
+## Reloading Changes
+
+### If autoloads change
+
+Run:
+
+```elisp
+(doom/reload)
+```
+
+### For other changes
+
+Use one of:
+
+```elisp
+(load-library "javelin") ; Reload the entire library
+```
+
+or
+
+```elisp
+(eval-buffer) ; Evaluate the current buffer (when editing javelin.el)
+```
