Skip to content

Commit 35f3a5a

Browse files
committed
Merge branch 'master' of https://github.com/adunato/writer
2 parents 44ac66f + df92175 commit 35f3a5a

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# Writer: An Extension for Text Generation Web UI
22
![Logo](./logo.png)
33

4-
Writer is an open-source AI writing application specifically designed for novel writing, it aims to explore new options for creative writing within the text generation webui framework.
4+
Writer is an open-source AI writing application specifically designed for novel writing, it aims to explore new options for creative writing with large language model support.
55

66
## Key Features :key:
77

8-
- **Summary Support**: Write or paste a story summary in the provided editor. This will provide necessary context to the LLM, assisting in generating content more aligned with your thoughts.
8+
- **Summary Support**: Write or paste a story summary in the summary section. This will provide necessary context to the LLM, assisting in generating content more aligned with the story background.
99

10-
- **Auto-Summarisation of Chapters**: Why writing the story summary when you can have the AI doing for you? Writer auto-summarises chapters, adding incremental context to your story.
10+
- **Auto-Summarisation of Chapters**: Instead of writing the story summary you can have the AI doing for you. Writer auto-summarises chapters, adding incremental context to your story. This can then be edited and tweaked.
1111

1212
- **Auto-Collation of Chapters**: Get your chapters organised automatically into a compiled story.
1313

14-
- **Export Options**: Finished writing? Export your masterpiece to HTML, Markdown, or txt format.
14+
- **Export Options**: Export your finished story to HTML, Markdown, or txt format.
1515

1616
## Installation :cd:
1717

1818
Please follow these steps to install Writer:
1919

2020
1. Open a bash terminal in *text-generation-webui\extensions*
2121
2. Type ``` git clone https://github.com/adunato/writer.git ```
22-
3. Restart text generation webui
22+
3. Restart Text Generation Web UI
2323

2424
## How To Use :book:
2525

2626
### Writer Pad :memo:
2727

28-
The Writer Pad is your primary workspace. It functions similarly to the Notebook mode in Text Generation Web UI. Use this text box to write, edit, and generate text as per your needs. For best LLM generation, keep each paragraph under the LLM tokens limit (e.g. 2000), then hit "Process Paragraph" and start a new one with the context from the previous ones fed automatically to the LLM.
28+
The Writer Pad is the primary workspace. It functions similarly to the Notebook mode in Text Generation Web UI. Use this text box to write, edit, and generate text as per your needs. For best LLM generation, keep each paragraph under the LLM tokens limit (e.g. 2000), then hit "Process Paragraph" and start a new one with the context from the previous ones fed automatically to the LLM.
2929

3030
### Session :floppy_disk:
3131

@@ -51,14 +51,12 @@ I want this app to be a sandbox for AI-assisted writing and I plan to experiment
5151

5252
## Contribution :handshake:
5353

54-
We're an open-source project and we welcome contributions! Check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get started.
54+
Suggestions and bug reports are welcome! Feel free to create issues and submit pull requests.
5555

5656
## License :page_with_curl:
5757

5858
This project is licensed under the [MIT License](./LICENSE).
5959

6060
---
6161

62-
Suggestions and bug reports are welcome! Feel free to create issues and submit pull requests.
63-
64-
If any of the above sounds like a corporate sales pitch, blame Chat GPT for overdoing its "grammar checks".
62+
If any of the above sounds like a corporate sales pitch, blame Chat GPT for getting carried away with its "grammar checks".

0 commit comments

Comments
 (0)