Skip to content

Commit 7997b4b

Browse files
README update
1 parent 0f86347 commit 7997b4b

File tree

1 file changed

+35
-8
lines changed

1 file changed

+35
-8
lines changed

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ effectively replacing proprietary providers Large Language Models (LLMs) web pla
2020

2121
| ![demo screenshot](screens/screenshot.3.png) |
2222
|:--:|
23-
| prompter.vim in action editing a prompt to simulate a phone conversation, with the tecnique below described as "dialogues as part of the text prompt" |
23+
| prompter.vim in action: editing/interacting with a prompt that simulate a phone conversation (with a tecnique below described as "dialogues as part of the text prompt")|
2424

2525
## ⚠ A Tool for Prompt Engineers, Not Coders!
2626

@@ -390,8 +390,28 @@ PrompterSetup <F9>
390390

391391
## 🛠 Other useful vim settings
392392

393-
- To read all statistics print of your completions:
393+
- Use (embedded in vim) spell checker!
394+
When you write a LLM prompt it's very very important to avoid typos!
395+
I many time experienced that LLM completion worst if you mistake just a verb.
396+
397+
Things go even worst if you are writing prompts in more than one languages.
398+
personally I usually write conversational prompts in English, for some reasons described in my article
399+
[Non-English Languages Prompt Engineering Trade-offs](https://convcomp.it/non-english-languages-prompt-engineering-trade-offs-7e529866faba),
400+
but the target langugae of the chat prompt is my native language: Italian.
401+
All in all the prompt contains text in both English and Italian. In this case I run this small vimscript function:
402+
394403
```viml
404+
function! Spell()
405+
set spelllang=en_us,it
406+
setlocal spell
407+
echom "Spell check set for Italian and English languages"
408+
endfunction
409+
com! SPELL call Spell()
410+
```
411+
412+
- To read all statistics print of your completions:
413+
414+
```viml
395415
messages
396416
```
397417
vim will show last completion statistics info. By example, if you just run 3 completions:
@@ -402,6 +422,12 @@ PrompterSetup <F9>
402422
```
403423

404424
- Enabling Soft Wrap
425+
426+
I usually work with a full-screen vim setting. That helps mme to maximize my attention.
427+
Nevertheless having very long lines (after a `PrompterGenerate`) doen't help the reading.
428+
Unfortunately, in vim is not easy to configure a fixed column width soft wrap.
429+
See [discussion](https://vi.stackexchange.com/questions/43028/how-to-soft-wrap-text-at-column-number-lower-than-window-width).
430+
You can set set soft warp with follwing command:
405431
```viml
406432
set wrap linebreak nolist
407433
```
@@ -457,12 +483,13 @@ Other vim commands that could be useful:
457483
map <F7> :normal oa: <CR>
458484
```
459485

460-
## OS Environment
486+
## Dev/Test Environment
461487

462-
- 😓 I developed on WLS (Window Linux Subsystem) on a Windows 10 operating system, using an Ubuntu 20.04 distribution.
463-
- 😊 I tested the plugin using Python 3.8.10 and 3.11
464-
- 🤔 As LLM provider, I tested just using my Azure OpenAI account.
465-
- 😊 Vim version: VIM - Vi IMproved 9.0
488+
- [x] Vim version: VIM - Vi IMproved 9.0
489+
- [x] I developed on WLS (Window Linux Subsystem) on a Windows 10 operating system, using an Ubuntu 20.04 distribution.
490+
- [x] I tested the plugin using both Python 3.8.10 and 3.11
491+
- [ ] As LLM provider, I tested just using my Azure OpenAI account.
492+
- [ ] I din't tested using an OpenAI account.
466493

467494

468495
## Features to do in future releases
@@ -509,7 +536,7 @@ Other vim commands that could be useful:
509536
## Similar projects
510537

511538
- [vim-ai](https://github.com/madox2/vim-ai)
512-
Very similar to prompter.vim. Nevertheless it's focused on code completion allowing small prompts from the command line.
539+
Very similar to prompter.vim, nevertheless it's focused on code completion allowing small prompts from the command line.
513540
- [llm.nvim](https://github.com/gsuuon/llm.nvim)
514541
Just for neovim. Pretty similar to prompter.vim in the concept, but more oriented to code completions
515542
- [llm.nvim](https://github.com/huggingface/llm.nvim)

0 commit comments

Comments
 (0)