branch: elpa/aidermacs
commit 71fabfacefc0c3a60dea920b17227e86f1c5e101
Author: Kang Tu <kang...@apple.com>
Commit: Kang Tu (aider) <kang...@apple.com>
docs: proofread and improve the English in the README file
---
README.org | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/README.org b/README.org
index 3602a64f85..ddbdc79f0f 100644
--- a/README.org
+++ b/README.org
@@ -1,29 +1,29 @@
-#+TITLE: aider.el : aider (AI pair programming) inside emacs
+#+TITLE: aider.el : Aider (AI Pair Programming) Inside Emacs
* Introduction
-- Do you like the AI feature of [[https://www.cursor.com/][cursor AI code
editor]], but don't want to leave emacs?
+- Do you like the AI features of [[https://www.cursor.com/][Cursor AI Code
Editor]], but prefer to stay within Emacs?
-- aider.el provides an interactive interface to communicate with
https://github.com/paul-gauthier/aider.
- - Most of elisp code in this repo was generated by aider / aider.el
+- Aider.el provides an interactive interface to communicate with
https://github.com/paul-gauthier/aider.
+ - Most of the Elisp code in this repository was generated by Aider /
Aider.el.
-* Why use aider.el in emacs?
+* Why Use Aider.el in Emacs?
-- Pop-up menu: No need to remember the command. (aider-transient-menu, bind to
C-c a by default)
+- Pop-up Menu: No need to remember commands. (aider-transient-menu, bound to
C-c a by default)
[[file:./transient_menu.png]]
-- Git repo specific aider session in emacs: automatically identify your git
repo of current file, and create a new aider session for it. Multiple aider
sessions can exist for different git repos.
+- Git Repository-Specific Aider Sessions in Emacs: Automatically identify the
Git repository of the current file and create a new Aider session for it.
Multiple Aider sessions can exist for different Git repositories.
-- Region based refactor support: You can select a region (eg. code block) in
file and ask aider to refactor that.
+- Region-Based Refactor Support: You can select a region (e.g., a code block)
in a file and ask Aider to refactor it.
-- .. And more: add your own elisp function to support your use case. For sure
you can ask aider / aider.el to do that.
+- And More: Add your own Elisp functions to support your use case. You can
certainly ask Aider / Aider.el to do that.
* Installation
-- [[https://aider.chat/docs/install.html][Install aider]]
-- Install dependency [[https://github.com/magit/transient][transient]] with
package manager
-- Install aider.el with following code
+- [[https://aider.chat/docs/install.html][Install Aider]]
+- Install the dependency [[https://github.com/magit/transient][Transient]]
using your package manager.
+- Install Aider.el with the following code:
#+BEGIN_SRC emacs-lisp
(use-package aider
@@ -37,5 +37,5 @@
[[file:./screenshot.png]]
-- In the above screenshot, aider was asked to generate a aider-help function,
and add corresponding entry to menu (right top window)
-- Aider get the command and generate the commit for it (left bottom
+- In the above screenshot, Aider was asked to generate an aider-help function
and add the corresponding entry to the menu (top right window).
+- Aider received the command and generated the commit for it (bottom left).
