branch: elpa/aidermacs
commit b412d331e54ec13c66ef221e7865d29db91ec41c
Author: tninja <[email protected]>
Commit: tninja <[email protected]>
docs(readme): reorganize features section for better readability
---
README.org | 28 +++++++++++++---------------
1 file changed, 13 insertions(+), 15 deletions(-)
diff --git a/README.org b/README.org
index e81ccfa1a6..dee6ab39ef 100644
--- a/README.org
+++ b/README.org
@@ -115,38 +115,36 @@ When being called with the universal argument (`C-u`), a
prompt will offer the u
- (`aider-switch-to-buffer`): Switch to the Aider buffer.
- use "^" in the menu to toggle open aider session in other window inside
current frame, or open a dedicate frame for aider session
-*** Model Selection:
- - (`aider-change-model`): Interactively select and change AI model in
current aider session
- - Customize `aider-popular-models` to define your preferred models list.
Default models are (as date of 2025-01-26):
- - anthropic/claude-3-5-sonnet-20241022 (really good in practical)
- - o3-mini (new released. very powerful, not expensive)
- - gemini/gemini-exp-1206 (free)
- - r1 (performance matches o1, price << claude sonnet. weakness: small
context)
- - deepseek/deepseek-chat (chatgpt-4o level performance, price is 1/100.
weakness: small context)
-
*** More ways to add files to the Aider buffer:
- use "@" in the menu to toggle add file between read-write mode and
read-only mode
- (`aider-add-current-file`): Add the current buffer file.
- (`aider-add-files-in-current-window`): Add all buffers in the current
window.
- - (`aider-add-same-type-files-under-dir`): Add all files with the same
suffix as the current file under the current directory to Aider.
- - (`aider-batch-add-dired-marked-files`): Add multiple Dired marked files to
the Aider buffer.
*** Write code:
- (`aider-function-or-region-refactor`): If a region is selected, ask Aider
to refactor the selected region. Otherwise, ask Aider to change / refactor the
function under the cursor.
- - *(`aider-implement-todo`): Implement requirement in comments in-place, in
current context.*
+ - (`aider-implement-todo`): Implement requirement in comments in-place, in
current context.
- If cursor is on a comment line, implement that specific comment in-place.
- If there is a selection region of multi-line comments, implement code
for those comments in-place.
- If cursor is inside a function, implement TODOs for that function.
- Otherwise implement TODOs for the entire current file.
+*** Support for Unit Test / Test Driven Development:
+ - (`aider-write-unit-test`): Generate comprehensive unit tests for the
current function or file. If the cursor is on a test function, implement the
test function.
+ - (`aider-fix-failing-test-under-cursor`): Place cursor on a failing test
function and ask Aider to analyze and fix the code to make tests pass. You can
provide more information of failed test case to help aider figuring out how to
fix the source code.
+
*** Explain code:
- (`aider-ask-question`): Ask Aider a question about the code in the current
context. If a region is selected, use the region as context.
- (`aider-function-or-region-explain`): If a region is selected, ask Aider
to explain the selected region. Otherwise, ask Aider to explain the function
under the cursor.
- (`aider-explain-symbol-under-point`): Ask Aider to explain the symbol
under cursor, given the line as context.
-*** Support for Unit Test / Test Driven Development:
- - (`aider-write-unit-test`): Generate comprehensive unit tests for the
current function or file. If the cursor is on a test function, implement the
test function.
- - (`aider-fix-failing-test-under-cursor`): Place cursor on a failing test
function and ask Aider to analyze and fix the code to make tests pass. You can
provide more information of failed test case to help aider figuring out how to
fix the source code.
+*** Model Selection:
+ - (`aider-change-model`): Interactively select and change AI model in
current aider session
+ - Customize `aider-popular-models` to define your preferred models list.
Default models are (as date of 2025-01-26):
+ - anthropic/claude-3-5-sonnet-20241022 (really good in practical)
+ - o3-mini (new released. very powerful, not expensive)
+ - gemini/gemini-exp-1206 (free)
+ - r1 (performance matches o1, price << claude sonnet. weakness: small
context)
+ - deepseek/deepseek-chat (chatgpt-4o level performance, price is 1/100.
weakness: small context)
*** And More:
You can add your own Elisp functions to support your specific use cases. Feel
free to ask Aider/`aider.el` to help you create them.
