branch: elpa/aidermacs
commit 9227f6b02ac58623af4852d2d1bc10874d8a455f
Author: Mingde (Matthew) Zeng <[email protected]>
Commit: Mingde (Matthew) Zeng <[email protected]>
Refine README
Signed-off-by: Mingde (Matthew) Zeng <[email protected]>
---
README.org | 33 +++++++++++++++++++--------------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/README.org b/README.org
index 3171c46fd6..dcf22179dd 100644
--- a/README.org
+++ b/README.org
@@ -3,7 +3,7 @@
* 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. As a community-driven
project, Aidermacs prioritizes the needs and preferences of Emacs users. It
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
@@ -12,7 +12,16 @@ Miss using [[https://cursor.sh][Cursor]] but prefer working
in Emacs? Aidermacs
- Broad language support including Python, JavaScript, TypeScript, PHP, HTML,
CSS, and more
- Compatibility with leading AI models like Claude 3.5 Sonnet, DeepSeek, and
GPT-4o
+* Community-Driven Development
+Aidermacs thrives on community involvement. We believe that the best software
is built collaboratively, with input from users and contributors. We encourage
you to:
+
+- Contribute Code: Submit pull requests with bug fixes, new features, or
improvements to existing functionality.
+- Report Issues: Let us know about any bugs, unexpected behavior, or feature
requests through GitHub Issues.
+- Share Ideas: Participate in discussions and propose new ideas for making
Aidermacs even better.
+- Improve Documentation: Help us make the documentation clearer, more
comprehensive, and easier to use.
+
+Your contributions are essential to making Aidermacs the best AI pair
programming tool for Emacs!
* 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]].
@@ -31,6 +40,10 @@ With =aidermacs=, you get:
- AI-generated code appears with proper syntax highlighting in major
languages.
- Ensures clarity and readability without additional configuration.
+3. Community-Focused 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 🚀
* Installation
@@ -68,29 +81,21 @@ In =config.el=:
(setq aider-args '("--model" "o3-mini")))
#+END_SRC
-* Core Features
+* 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
-Available models (as of 2025-01-26):
-- anthropic/claude-3-5-sonnet-20241022 (recommended)
-- o3-mini (cost-effective)
-- gemini/gemini-exp-1206 (free)
-- r1 (compact context)
-- deepseek/deepseek-chat (budget-friendly)
-
-* Optional Features
+** Optional Features
Helm Integration
For fuzzy command history searching:
@@ -99,7 +104,7 @@ For fuzzy command history searching:
: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
