tristan/gptel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

gptel: Update commentary and README

Browse source
This commit is contained in:
Karthik Chikmagalur 2023-03-19 19:58:19 -07:00
parent f0eba0cf4f
commit 4f3ca23454
2 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.org
View file

@ -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]]

20
gptel.el
View file

@ -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")