branch: elpa/aidermacs
commit 8ffd82740ebb4cf21627d71c91549c7f97acb378
Author: Mingde (Matthew) Zeng <[email protected]>
Commit: Mingde (Matthew) Zeng <[email protected]>
Fix README
Signed-off-by: Mingde (Matthew) Zeng <[email protected]>
---
README.org | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/README.org b/README.org
index b49691a84d..3171c46fd6 100644
--- a/README.org
+++ b/README.org
@@ -1,9 +1,9 @@
-#+TITLE: aidermacs : Aider AI Pair Programming for Emacs
+#+TITLE: aidermacs: Aider AI Pair Programming for Emacs
#+OPTIONS: toc:2
* Introduction
-Miss using [[https://cursor.sh][Cursor]] but prefer working in Emacs?
Aidermacs brings Cursor-like AI-powered development to your Emacs workflow by
integrating [[https://github.com/paul-gauthier/aider][Aider]], one of the most
powerful **open-source** AI pair programming tools available. Aidermacs
provides the same powerful features you'd find in Cursor:
+Miss using [[https://cursor.sh][Cursor]] but prefer working in Emacs?
Aidermacs brings Cursor-like AI-powered development to your Emacs workflow by
integrating [[https://github.com/paul-gauthier/aider][Aider]], one of the most
powerful open-source AI pair programming tools available. Aidermacs provides
the same powerful features you'd find in Cursor:
- Top performance on the SWE Bench, solving real GitHub issues in major open
source projects
- Seamless Git integration with automatic, sensible commit messages
@@ -15,32 +15,32 @@ Miss using [[https://cursor.sh][Cursor]] but prefer working
in Emacs? Aidermacs
* Why aidermacs over aider.el?
-Aidermacs begins as a fork of
[[https://github.com/tninja/aider.el][aider.el]], created to offer a more
Emacs-native experience while still integrating with
[[https://github.com/paul-gauthier/aider][Aider]], a powerful AI pair
programming tool.
+Aidermacs begins as a fork of
[[https://github.com/tninja/aider.el][aider.el]], created to offer a more
Emacs-native experience while still integrating with
[[https://github.com/paul-gauthier/aider][Aider]].
-While =aider.el= strictly mirrors Aider's CLI behavior, =aidermacs=
prioritizes Emacs usability and native workflow integration. This design
philosophy allows you to harness Aider's powerful capabilities through a
natural, Emacs-native coding experience.
+While =aider.el= strictly mirrors Aider's CLI behavior, =aidermacs=
prioritizes Emacs workflow integration. This design philosophy allows you to
harness Aider's powerful capabilities through a natural, Emacs-native coding
experience.
With =aidermacs=, you get:
1. Better Support for Multiline Input
- - =aider= is primarily designed as a command-line program, where multi-line
input is restricted by terminal limitations.
- - Terminal-based tools require special syntax or manual formatting to
handle multi-line input, which can be cumbersome and unintuitive.
- - =aidermacs= **eliminates these restrictions** by handling multi-line
prompts natively within Emacs, allowing you to compose complex AI requests just
like any other text input.
- - Whether you're pasting blocks of code or refining AI-generated responses,
multiline interactions in =aidermacs= feel **natural and seamless**.
+ - =aider= is primarily designed as a command-line program, where multiline
input is restricted by terminal limitations.
+ - Terminal-based tools require special syntax or manual formatting to
handle multiline input, which can be cumbersome and unintuitive.
+ - =aidermacs= eliminates these restrictions by handling multiline prompts
natively within Emacs, allowing you to compose complex AI requests just like
any other text input.
+ - Whether you're pasting blocks of code or refining AI-generated responses,
multiline interactions in =aidermacs= feel natural and seamless.
2. Smarter Syntax Highlighting
- - AI-generated code **appears with proper syntax highlighting** in major
languages.
+ - AI-generated code appears with proper syntax highlighting in major
languages.
- Ensures clarity and readability without additional configuration.
... and more to come 🚀
* Installation
-** Requirements
+ Requirements
- Emacs ≥ 26.1
- [[https://aider.chat/docs/install.html][Aider]]
- [[https://github.com/magit/transient][Transient]] and
[[https://github.com/magit/magit][Magit]]
-** With Straight
+ With Straight
#+BEGIN_SRC emacs-lisp
(use-package aidermacs
:straight (:host github :repo "MatthewZMD/aidermacs" :files ("aider.el"))
@@ -50,12 +50,12 @@ With =aidermacs=, you get:
(global-set-key (kbd "C-c a") 'aider-transient-menu))
#+END_SRC
-** With package-vc-install
+ With package-vc-install
#+BEGIN_SRC emacs-lisp
(package-vc-install '(aider :url "https://github.com/MatthewZMD/aidermacs";))
#+END_SRC
-** For Doom Emacs
+ For Doom Emacs
In =packages.el=:
#+BEGIN_SRC emacs-lisp
(package! aider :recipe (:host github :repo "MatthewZMD/aidermacs" :files
("aider.el" "aider-doom.el")))
@@ -70,19 +70,19 @@ In =config.el=:
* Core Features
-** Session Management
+ Session Management
- Create repository-specific Aider sessions
- Switch between multiple AI sessions
- Toggle between window and frame views
-** Code Operations
+ Code Operations
- Add files in read-write or read-only mode
- Refactor selected regions or functions
- Implement TODOs from comments
- Generate and fix unit tests
- Analyze and explain code
-** AI Model Selection
+ AI Model Selection
Available models (as of 2025-01-26):
- anthropic/claude-3-5-sonnet-20241022 (recommended)
- o3-mini (cost-effective)
@@ -92,14 +92,14 @@ Available models (as of 2025-01-26):
* Optional Features
-** Helm Integration
+ Helm Integration
For fuzzy command history searching:
#+BEGIN_SRC emacs-lisp
(use-package aider
:straight (:host github :repo "MatthewZMD/aidermacs" :files ("aider.el"
"aider-helm.el")))
#+END_SRC
-** Prompt Management
+ Prompt Management
Access repository-specific prompt files with =C-c a p= for organizing and
reusing prompts.
* Development Workflow
