summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2025-11-04 09:41:22 -0600
committerCraig Jennings <c@cjennings.net>2025-11-04 09:41:22 -0600
commit88efdbc62d9f0c3df2b581b9b0fbc302be71faba (patch)
tree0ab690bd7ac6c92b1e5db97348e92f639f5d69d6 /README.org
parentf6f9e52b732606d9c5553ce9591eaef660600643 (diff)
docs:README: Add VC install instructions
Include detailed steps for installing Wttrin using package-vc in Emacs 30 or later.
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.org b/README.org
index 4f95713..c07561d 100644
--- a/README.org
+++ b/README.org
@@ -29,6 +29,20 @@ Wttrin is on [[https://melpa.org/][MELPA]] and [[https://stable.melpa.org/#/][ME
With the cursor after the last closing parentheses, press "C-x C-e". Emacs will start the install, assign the keybinding, set the location list, and you'll be ready to go.
+*** Package VC Install (Emacs 30+)
+If you're running Emacs 30 or later, you can install Wttrin directly from its Git repository using the built-in package-vc system. This is particularly handy if you want to track the latest development or contribute bug fixes.
+
+#+begin_src emacs-lisp
+ (unless (package-installed-p 'wttrin)
+ (package-vc-install "https://github.com/cjennings/emacs-wttrin" nil nil 'wttrin))
+ (use-package wttrin
+ :bind ("C-c w" . wttrin)
+ :custom
+ (wttrin-default-locations '("Jeffreys Bay" "Raglan" "Mundaka")))
+#+end_src
+
+The package-vc system automatically handles updates when you run `M-x package-vc-upgrade`, making it easy to stay current with the main branch.
+
*** Straight
For the Elisp hackers using Straight for lockfiles or for easy hacking on bug fix PRs, you probably don't need me to tell you what to put in your Emacs init, but here it is anyway.