From 4f3ca234545a3643eb3bed2baf55645463b6f728 Mon Sep 17 00:00:00 2001 From: Karthik Chikmagalur Date: Sun, 19 Mar 2023 19:58:19 -0700 Subject: [PATCH] gptel: Update commentary and README --- README.org | 2 ++ gptel.el | 20 ++++++++++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/README.org b/README.org index dd88571..e1d0b6c 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,7 @@ #+title: GPTel: A simple ChatGPT client for Emacs +[[https://melpa.org/#/gptel][file:https://melpa.org/packages/gptel-badge.svg]] + GPTel is a simple, no-frills ChatGPT client for Emacs. [[file:img/gptel.png]] diff --git a/gptel.el b/gptel.el index 52b0b4d..1961f89 100644 --- a/gptel.el +++ b/gptel.el @@ -27,7 +27,7 @@ ;;; Commentary: -;; A ChatGPT client for Emacs. +;; A simple ChatGPT client for Emacs. ;; ;; Requirements: ;; - You need an OpenAI API key. Set the variable `gptel-api-key' to the key or to @@ -36,12 +36,20 @@ ;; - Not required but recommended: Install `markdown-mode'. ;; ;; Usage: -;; - M-x gptel: Start a ChatGPT session -;; - C-u M-x gptel: Start another or multiple independent ChatGPT sessions +;; gptel can be used in any buffer or in a dedicated chat buffer. ;; -;; - In the GPT session: Press `C-c RET' (control + c, followed by return) to send -;; your prompt. -;; - To jump between prompts, use `C-c C-n' and `C-c C-p'. +;; To use this in a dedicated buffer: +;; - M-x gptel: Start a ChatGPT session +;; - C-u M-x gptel: Start another session or multiple independent ChatGPT sessions +;; +;; - In the chat session: Press `C-c RET' (`gptel-send') to send +;; your prompt. Use a prefix argument (`C-u C-c RET') to set chat parameters. +;; +;; To use this in any buffer: +;; +;; - Select a region of text and call `gptel-send'. Call with a prefix argument +;; to set chat parameters. +;; - You can select previous prompts and responses to continue the conversation. ;;; Code: (declare-function markdown-mode "markdown-mode")