branch: elpa/aidermacs
commit 257fe7e8f0843742312fbd6d51ba0e41262eb49f
Author: Kang Tu <kang...@apple.com>
Commit: Kang Tu <kang...@apple.com>
docs: improve README.org organization with clear sections
---
README.org | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index 9967a8bddc..564e22a973 100644
--- a/README.org
+++ b/README.org
@@ -15,30 +15,32 @@
[[file:./transient_menu.png]]
-- Aider session management:
- - (`aider-run-aider`): Create a comint-based, git repo specific buffer and
run "aider" for interactive conversation.
+- Following command integrated to aider session
+
+*** Aider session management:
+ - (`aider-run-aider`): Create a comint-based, *git repo specific aider
session* for interactive conversation.
- Git repository identification is based on the file path of of the
current file
- Multiple Aider sessions can exist for different Git repositories
- (`aider-switch-to-buffer`): Switch to the Aider buffer.
-- More ways to add files to the Aider buffer:
+*** More ways to add files to the Aider buffer:
- (`aider-add-current-file`): Add the current buffer file.
- (`aider-current-file-read-only`): Add the current buffer file as read-only.
- (`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.
-- Refactor code:
+*** Refactor code:
- (`aider-function-or-region-refactor`): If a region is selected, ask Aider
to refactor the selected region. Otherwise, ask Aider to refactor the function
under the cursor.
-- Explain code:
+*** Explain code:
- (`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 Test Driven Development:
+*** Support for Test Driven Development:
- (`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.
-- And More: Add your own Elisp functions to support your use case. You can
certainly 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
