You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,31 @@
1
1
# Writer: An Extension for Text Generation Web UI
2
2

3
3
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.
5
5
6
6
## Key Features :key:
7
7
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.
9
9
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.
11
11
12
12
-**Auto-Collation of Chapters**: Get your chapters organised automatically into a compiled story.
13
13
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.
15
15
16
16
## Installation :cd:
17
17
18
18
Please follow these steps to install Writer:
19
19
20
20
1. Open a bash terminal in *text-generation-webui\extensions*
21
21
2. Type ``` git clone https://github.com/adunato/writer.git ```
22
-
3. Restart text generation webui
22
+
3. Restart Text Generation Web UI
23
23
24
24
## How To Use :book:
25
25
26
26
### Writer Pad :memo:
27
27
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.
29
29
30
30
### Session :floppy_disk:
31
31
@@ -51,14 +51,12 @@ I want this app to be a sandbox for AI-assisted writing and I plan to experiment
51
51
52
52
## Contribution :handshake:
53
53
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.
55
55
56
56
## License :page_with_curl:
57
57
58
58
This project is licensed under the [MIT License](./LICENSE).
59
59
60
60
---
61
61
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