Clarify Forge-LLM dependencies and usage

- Update README to explicitly state that `forge` is essential.
- Emphasize that Forge-LLM commands operate within `forge-post-mode`.
- Add a prominent note in `forge-llm.el` regarding Forge dependency.
- Clarify the intended usage context of Forge-LLM.
This commit is contained in:
Roger Gonzalez 2025-04-03 10:33:10 -03:00
parent 217d3ad6d3
commit 62c925deff
Signed by: rogs
GPG Key ID: C7ECE9C6C36EC2E6
2 changed files with 6 additions and 2 deletions

View File

@ -33,7 +33,7 @@ Main features:
:ID: f30fedc1-a24a-4308-bc78-6f9c01857c18
:END:
- [[https://magit.vc/][Magit]] and [[https://github.com/magit/forge][Forge]]
- [[https://magit.vc/][Magit]] and [[https://github.com/magit/forge][Forge]] (**Note:** `forge` is essential for this package to operate)
- [[https://github.com/ahyatt/llm][llm]]
- Emacs 25.1+
@ -222,7 +222,7 @@ machine api.openai.com login apikey password YOUR-API-KEY-HERE
:ID: e6753914-01ee-41e9-bcdf-f3d6e75ee451
:END:
After setting up ~forge-llm~, the following commands will be available in Forge's pull request creation buffer:
After setting up ~forge-llm~, the following commands will be available *specifically within Forge's pull request creation buffer* (which runs in `forge-post-mode`):
| Key binding | Command | Description |
|------------------------+--------------------------------------------+-------------------------------------------------------|

View File

@ -28,6 +28,10 @@
;; high-quality Pull Request descriptions automatically using an LLM (Language
;; Learning Model) like OpenAI's GPT models or other compatible providers.
;;
;; **Important:** This package requires the `forge` package to be installed and
;; configured. Its primary functionality is designed to work within Forge's
;; pull request creation buffer (`forge-post-mode`).
;;
;; Features:
;; - Automatically detect and use repository PR templates
;; - Generate PR descriptions based on git diffs between branches