Skip to content

Commit

Permalink
update to README
Browse files Browse the repository at this point in the history
  • Loading branch information
balisujohn committed Jul 26, 2024
1 parent c3ddc4a commit 6a5b999
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# localwriter
# localwriter: A LibreOffice extension for local generative AI

Consider donating to support development: https://ko-fi.com/johnbalis

Expand All @@ -16,10 +16,12 @@ Some example use cases for this include, writing a story or an email given a par
### Edit Selection
A dialog box appears to prompt the user for instructions about how to edit the selected text, then the selected text is replaced by the edited text.

So examples for use cases for this include changing the tone of an email, translating text to a different language, and semantically editing a scene in a story.
Some examples for use cases for this include changing the tone of an email, translating text to a different language, and semantically editing a scene in a story.

## Setup

First go to tags, and download the most recent version of `localwriter.oxt`.

In libreoffice, Navigate to Tools, then Extensions Manager, then click `Add` and find the `localwriter.oxt` file in your filesystme. You will be directed to read the license then the extension should be installed.

You will also need to setup `text-generation-webui`, and enable the local openai API (note that this just means in this mode `text-generation-webui` will respond in the same format as open AI, all the computation still happens on your computer!). You can use whatever model you want, but I'd recommend openchat3.5 if you don't have a particular model in mind and have only 8 gigabytes of VRAM. Once the OpenAI-style API is running on localhost port 5000, localwriter should work with no additional steps.
Expand Down

0 comments on commit 6a5b999

Please sign in to comment.