branch: elpa/aidermacs
commit 80169ffd2120b10facf7f46c6688d4494f44f355
Author: Mingde (Matthew) Zeng <[email protected]>
Commit: Mingde (Matthew) Zeng <[email protected]>
Update README
Signed-off-by: Mingde (Matthew) Zeng <[email protected]>
---
README.org | 33 ++++++++++++++++-----------------
1 file changed, 16 insertions(+), 17 deletions(-)
diff --git a/README.org b/README.org
index bac5145228..feda7ab684 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,4 @@
-#+TITLE: aidermacs: Aider AI Pair Programming in Emacs
+#+TITLE: Aidermacs: AI Pair Programming in Emacs
#+OPTIONS: toc:2
* Introduction
@@ -23,25 +23,25 @@ Aidermacs thrives on community involvement. We believe that
the best software is
Your contributions are essential to making Aidermacs the best AI pair
programming tool for Emacs!
-* Why aidermacs over aider.el?
+* 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]].
-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.
+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:
+With =Aidermacs=, you get:
1. Better Support for Multiline Input
- =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.
+ - =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.
- Ensures clarity and readability without additional configuration.
3. Flexible Terminal Backend Support
- - =aidermacs= supports multiple terminal backends (comint and vterm) for
better compatibility and performance
+ - =Aidermacs= supports multiple terminal backends (comint and vterm) for
better compatibility and performance
- Easy configuration to choose your preferred terminal emulation
- Extensible architecture for adding new backends
@@ -51,14 +51,13 @@ With =aidermacs=, you get:
- View output history with =M-x aidermacs-show-output-history=
- and more
-5. Community-Driven Development
- - =aidermacs= is actively developed and maintained by the community,
incorporating user feedback and contributions.
- - We prioritize features and improvements that directly benefit Emacs
users, ensuring a tool that evolves with your needs.
-
6. Greater Configurability
- - =aidermacs= offers more customization options to tailor the experience
to your preferences.
+ - =Aidermacs= offers more customization options to tailor the experience
to your preferences.
- You can easily disable automatic commits, choose to operate only within
a specific directory, and customize keybindings.
- - =aider.el= lacks these configuration options, offering a less flexible
experience.
+
+5. Community-Driven Development
+ - =Aidermacs= is actively developed and maintained by the community,
incorporating user feedback and contributions.
+ - We prioritize features and improvements that directly benefit Emacs
users, ensuring a tool that evolves with your needs.
... and more to come 🚀
@@ -88,7 +87,7 @@ With =aidermacs=, you get:
** Terminal Backend Selection
-Choose your preferred terminal backend by setting =aidermacs-backend=:
+Choose your preferred terminal backend by setting =Aidermacs-backend=:
=vterm= provides better terminal compatibility and bracketed paste support,
while =comint= is a simpler, built-in option.
@@ -103,7 +102,7 @@ Available backends:
** Disabling Auto-Commits
-By default, Aidermacs automatically commits changes made by the AI. Some users
may find this behavior disruptive. You can disable auto-commits by setting
=aidermacs-auto-commits= to =nil=:
+By default, Aidermacs automatically commits changes made by the AI. Some users
may find this behavior disruptive. You can disable auto-commits by setting
=Aidermacs-auto-commits= to =nil=:
#+BEGIN_SRC emacs-lisp
;; Disable auto-commits
@@ -131,7 +130,7 @@ This section provides a step-by-step guide on how to use
Aidermacs for AI-assist
- Use the command =M-x aidermacs-run-aidermacs= (=a= in transient menu) to
start an Aidermacs session.
- This will open a new buffer named =*aidermacs:your-repo-name*= where you can
interact with the AI.
-- If you want to use a specific AI model, you can customize the
=aidermacs-args= variable in your Emacs configuration.
+- If you want to use a specific AI model, you can customize the
=Aidermacs-args= variable in your Emacs configuration.
- You can also select a model interactively by using =M-x
aidermacs-change-model= (=o= in transient menu).
** 2. Add Files to the Session
@@ -233,7 +232,7 @@ Session management commands:
- Access all commands through the transient menu: =M-x
aidermacs-transient-menu=
- The transient menu is a popup menu that provides a convenient way to access
all aidermacs commands.
- The menu groups commands into categories:
- - "Session Control": Basic session management (=a=, .=, =z=, =o=, =l=, =s=,
=x=)
+ - "Session Control": Basic session management (=a=, =.=, =z=, =o=, =l=, =s=,
=x=)
- "File Management": File management (=f=, =R=, =w=, =d=, =b=, =L=, =D=)
- "Code Actions": Code modifications (=c=, =r=, =i=, =t=, =u=)
- "Testing": Unit tests and debugging (=U=, =T=, =X=)
