Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Some fixes to formatting and language.
  • Loading branch information
tmmvn authored Aug 29, 2024
1 parent 7b84e56 commit bdb1c5a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@ BBEdit has good documentation on how to customize the functionality. If you can'

## Contents
### Chat API Descriptions
BBEdit 15.1 got a new feature allowing to use other AI services then ChatGPT for the AI Worksheets. This folder contains config templates for Google's Gemini API and Gemini on Vertex AI API. I think neither are currently fully functional due to the differences in the payloads and, in the case of Gemini API, how the params are part of the URL. Maybe in 15.2... Or maybe they already work.
BBEdit 15.1 got a new feature allowing to use other AI services than ChatGPT for the AI Worksheets. This folder contains config templates for Google's Gemini API and Gemini on Vertex AI API. I think neither are currently fully functional due to the differences in the payloads and, in the case of Gemini API, how the params are part of the URL. Maybe in 15.2... Or maybe they already work.

### AI Assistant Text Filters
There are three Text Filters that provide limited AI assistant functionality to BBEdit. The scripts are written in ruby, and utilize Google's PALM2 API. You will need your own API key for the filters to work. Replace the key variable string with your key inside the script file. But don't commit that as leaking the key is bad! If you wish to use OpenAI, switching the url endpoint and parameters should be easy.

All the text filters work on the selected text. If not text is selected, I think BBEdit will send the whole document in. This will likely get you past the token limit supported in LLMs, so try to work in chunks.
All the text filters work on the selected text. If not text is selected, I think BBEdit will send the whole document in. This will likely get you past the token limit supported in LLMs, so try to work in chunks.

The three filters are described below.
The three filters are described below.

#### AI - Debug
Select a block of code that is not working, and the AI assistant will try to give a suggestion to fix the code. The prompt will use whatever language is set for the document in BBEdit.
Select a block of code that is not working, and the AI assistant will try to give a suggestion to fix the code. The prompt will use whatever language is set for the document in BBEdit.

#### AI - Generator
Can be used to generate new code. For example, you could write "Create a python 3 function that takes an input and multiplies it by 3.", select that text, apply the filter, and the text will be replaced by the response from the AI assistant.
Can be used to generate new code. For example, you could write "Create a python 3 function that takes an input and multiplies it by 3.", select that text, apply the filter, and the text will be replaced by the response from the AI assistant.

#### AI - Suggestions
A suggestions module. Not super useful as it does not provide copilot level of interactivity due to the need to invoke manually and also due to the latency added. Will provide suggestions for what the AI thinks should be the next 5 lines of code.
A suggestions module. Not super useful as it does not provide copilot level of interactivity due to the need to invoke manually and also due to the latency added. Will provide suggestions for what the AI thinks should be the next 5 lines of code.

### Two crude language support implementations
Ansible Playbooks and Serverless. Both are pretty much just extensions to yml, but as I have yet to figure out if I can somehow use the compiled YML BBEdit module inside BBEdit as a base, these are just a simple keyword based addition.

### Two themes
Two themes: MSDOS and Eclipse. MS-DOS is for old geezers like me, who started coding in the days of MS-DOS. See image 1 below for what it looks like. Eclipse is inspired by the Eclipse IDE. See image 2 below for what that one looks like. Both are not overly polished yet, but functional.
Two themes: MSDOS and Eclipse. MS-DOS is for old geezers like me, who started coding in the days of MS-DOS. See image 1 below for what it looks like. Eclipse is inspired by the Eclipse IDE. See image 2 below for what that one looks like. Neither is overly polished yet, but functional.

![Screenshot of BBEdit with MS DOS Theme](/ss1.png)
Image 1. A screenshot of BBEdit with MS-DOS inspired theme.
Expand Down

0 comments on commit bdb1c5a

Please sign in to comment.