branch: elpa/gptel
commit 88f066d829f11f53fdcb39d26ac34b0492f02687
Author: Karthik Chikmagalur <karthikchikmaga...@gmail.com>
Commit: Karthik Chikmagalur <karthikchikmaga...@gmail.com>
README: Reorder usage section
* README.org: Reorder usage section for readability.
---
README.org | 47 +++++++++++++++++++++++++----------------------
1 file changed, 25 insertions(+), 22 deletions(-)
diff --git a/README.org b/README.org
index 8d9fd9751e..3c096c3c0b 100644
--- a/README.org
+++ b/README.org
@@ -76,6 +76,7 @@ gptel uses Curl if available, but falls back to url-retrieve
to work without ext
- [[#in-a-dedicated-chat-buffer][In a dedicated chat buffer:]]
- [[#save-and-restore-your-chat-sessions][Save and restore your chat
sessions]]
- [[#include-more-context-with-requests][Include more context with
requests]]
+ - [[#rewrite-refactor-or-fill-in-a-region][Rewrite, refactor or fill in a
region]]
- [[#extra-org-mode-conveniences][Extra Org mode conveniences]]
- [[#faq][FAQ]]
-
[[#i-want-the-window-to-scroll-automatically-as-the-response-is-inserted][I
want the window to scroll automatically as the response is inserted]]
@@ -723,28 +724,6 @@ The above code makes the backend available to select. If
you want it to be the
- or to replace the prompt with the response.
#+html: <img
src="https://github.com/karthink/gptel/assets/8607532/3562a6e2-7a5c-4f7e-8e57-bf3c11589c73";
align="center" alt="Image showing gptel's menu with some of the available
query options.">
-
-With a region selected, you can also rewrite prose or refactor code from here:
-
-*Prose*:
-
-#+html: <img
src="https://github.com/user-attachments/assets/172e75cd-11e9-4f3b-9ab9-b4edfb8f6695";
align="center" />
-
-#
[[https://user-images.githubusercontent.com/8607532/230770352-ee6f45a3-a083-4cf0-b13c-619f7710e9ba.png]]
-
-*Code*:
-
-#+html: <img
src="https://github.com/user-attachments/assets/8670ddb3-8655-47f4-a70c-8994994e61e3";
align="center" />
-
-#
[[https://user-images.githubusercontent.com/8607532/230770162-1a5a496c-ee57-4a67-9c95-d45f238544ae.png]]
-
-When the refactor is ready, you can apply it or compare against the original:
-
-#+html: <img
src="https://github.com/user-attachments/assets/a0cf33b2-3ad3-4f55-aa7b-4349e54d6771";
align="center" />
-
-These actions are also available directly when the cursor is inside the
pending rewrite region:
-
-#+html: <img
src="https://github.com/user-attachments/assets/57e1fff7-f8e4-47f0-9bda-d0b698443559";
align="center" />
*** In a dedicated chat buffer:
@@ -778,6 +757,30 @@ You can examine the active context from the menu:
And then browse through or remove context from the context buffer:
#+html: <img
src="https://github.com/karthink/gptel/assets/8607532/79a5ffe8-3d63-4bf7-9bf6-0457ab61bf2a";
align="center" alt="Image showing gptel's context buffer.">
+*** Rewrite, refactor or fill in a region
+
+In any buffer: with a region selected, you can rewrite prose or refactor code
from here:
+
+*Prose*:
+
+#+html: <img
src="https://github.com/user-attachments/assets/172e75cd-11e9-4f3b-9ab9-b4edfb8f6695";
align="center" />
+
+#
[[https://user-images.githubusercontent.com/8607532/230770352-ee6f45a3-a083-4cf0-b13c-619f7710e9ba.png]]
+
+*Code*:
+
+#+html: <img
src="https://github.com/user-attachments/assets/8670ddb3-8655-47f4-a70c-8994994e61e3";
align="center" />
+
+#
[[https://user-images.githubusercontent.com/8607532/230770162-1a5a496c-ee57-4a67-9c95-d45f238544ae.png]]
+
+When the refactor is ready, you can apply it or compare against the original:
+
+#+html: <img
src="https://github.com/user-attachments/assets/a0cf33b2-3ad3-4f55-aa7b-4349e54d6771";
align="center" />
+
+These actions are also available directly when the cursor is inside the
pending rewrite region:
+
+#+html: <img
src="https://github.com/user-attachments/assets/57e1fff7-f8e4-47f0-9bda-d0b698443559";
align="center" />
+
*** Extra Org mode conveniences
gptel offers a few extra conveniences in Org mode.
