branch: elpa/aidermacs
commit 3a5199e42db4ab0fa137d74872208b624d8c8cd2
Author: Christian Stewart <christ...@aperture.us>
Commit: Matthew Zeng <matthew...@posteo.net>
readme: add spacemacs example
Signed-off-by: Christian Stewart <christ...@aperture.us>
---
README.md | 23 ++++++++++++++++++++++-
1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7fe3799272..7b9ea85ceb 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,28 @@ Here's what the community is saying about Aidermacs:
(aidermacs-use-architect-mode t)
(aidermacs-default-model "sonnet"))
```
-3. Open a project and run `M-x aidermacs-transient-menu` or `C-c a` (where you
bind it)
+
+### Spacemacs
+
+For **Spacemacs** users:
+
+1. Add `aidermacs` to your `dotspacemacs-additional-packages` list in your
`.spacemacs` file:
+```emacs-lisp
+dotspacemacs-additional-packages '(
+ (aidermacs :variables
+ aidermacs-use-architect-mode t
+ aidermacs-default-model "sonnet")
+)
+```
+
+2. Add the keybinding to your `dotspacemacs/user-config` function in
`.spacemacs`:
+```emacs-lisp
+(defun dotspacemacs/user-config ()
+ ;; Set leader key for Aidermacs
+ (spacemacs/set-leader-keys "aa" 'aidermacs-transient-menu) ; Example binding
SPC a a
+)
+```
+3. Open a project and run `M-x aidermacs-transient-menu` or `SPC a a` (or your
chosen binding).
4. Add files and start coding with AI!
## Usage
