Skip to content

Commit cf1669d

Browse files
committed
update readme, etc.
1 parent 9fd32ab commit cf1669d

File tree

3 files changed

+23
-10
lines changed

3 files changed

+23
-10
lines changed

LazWritingTools.lpi

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
</SearchPaths>
7979
<Linking>
8080
<Debugging>
81+
<GenerateDebugInfo Value="False"/>
8182
<RunWithoutDebug Value="True"/>
8283
<DebugInfoType Value="dsDwarf3"/>
8384
</Debugging>

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Writing Tools
22

3-
https://github.com/user-attachments/assets/6a530cd7-2953-4a89-ac87-ca3b40e7b07e
3+
https://github.com/user-attachments/assets/e0a798a1-4482-45b0-afba-f9b512d3aa5e
44

55

66
## 🚀 What is it?
@@ -30,7 +30,7 @@ Based on [ChatLLM.cpp](https://github.com/foldl/chatllm.cpp), and built with [De
3030
- **Completely free and Open-source**: Purely native. Bloat-free & uses pretty much **0% of your CPU**.
3131
- **Chat Mode**: Seamlessly switching between context processing mode and chat mode.
3232
- **Customization**: All commands are fully customizable.
33-
- **Markdown Rendering**: Beautiful and elegant.
33+
- **Markdown/Math Rendering**: Beautiful and elegant.
3434

3535
## ✨ Features
3636

@@ -60,15 +60,17 @@ Invoke Writing Tools with no text selected to enter quick chat mode.
6060

6161
1. Configure your profile.
6262

63-
Copy `profile.json.in` to `profile.json`. Fill in the path of the quantized model file:
63+
Copy `profile.json.in` to `profile.json`. Fill in the path of the quantized model file and other options (see [ChatLLM.cpp](https://github.com/foldl/chatllm.cpp)):
6464

6565
```js
6666
{
6767
//...
6868
"chatllm": {
6969
"default": [
7070
"-m",
71-
"path of the quantized model file"
71+
"path of the quantized model file",
72+
"-ngl", "all", // for GPU acceleration
73+
"+detect-thoughts" // detect thoughts
7274
]
7375
},
7476
//...
@@ -127,6 +129,8 @@ _Actions_ are represented to users as a collection of buttons. Each action is de
127129
"llm": "another_one", // optional
128130
"ai_prefix": "...", // optional
129131
"ai_suffix": "...", // optional
132+
"feels_lucky": true, // optional (true or false)
133+
"web_app": "..." // optional
130134
"action": "show" // optional
131135
}
132136
```
@@ -138,6 +142,11 @@ _Actions_ are represented to users as a collection of buttons. Each action is de
138142
* `llm` is selected LLM to serve this action (when omitted, "default" is selected).
139143
* `ai_prefix` is used for [generation steering](https://github.com/foldl/chatllm.cpp/blob/master/docs/fun.md#generation-steering).
140144
* `ai_suffix` is used abort generation: once this suffix is found in LLM's output, generation is aborted.
145+
* `feels_lucky` is a flag to accept the first round of LLM's output. When set to `false` (default), users can click _Redo_ button to try again.
146+
* `web_app` is a special field providing additional functionalities on LLM's output (when `feels_lucks` is `false`). Possible values:
147+
148+
- `diff`: compare LLM's suggestion and original text (useful for _proofreading_ like actions).
149+
141150
* `action` is the post action to handle the output of LLM. Possible values:
142151

143152
- `show`: show the output in a box.
@@ -234,32 +243,35 @@ Add a shortcut of the `WritingTools.exe` to the Windows Start-Up folder.
234243

235244
## 👨‍💻 To compile the application yourself:
236245

237-
Precondition: Build `libchatllm` or get `libchatllm.dll` & `ggml.dll` from releases;
246+
Precondition: Build `libchatllm` or get `*.dll` from releases;
238247

239248
### Delphi
240249

241250
1. Install [Delphi Community Edition](https://www.embarcadero.com/products/delphi/starter/free-download/);
242251
1. Build this project (Target: Win64);
243-
1. Copy `libchatllm.dll` & `ggml.dll` to the output directory (such as _Win64/Debug_).
252+
1. Copy all `*.dll` files to the output directory (such as _Win64/Debug_).
244253

245254
### Lazarus
246255

247256
1. Install [Lazarus](https://www.lazarus-ide.org/) Win64;
248257
1. Install package [WebView4Delphi](https://github.com/salvadordf/WebView4Delphi) to Lazarus;
249258
1. Build this project (_LazWritingTools.lpi_);
250-
1. Copy `libchatllm.dll` & `ggml.dll` to the output directory (such as _lib/x86\_64-win64_).
259+
1. Copy all `*.dll` files to the output directory (such as _lib/x86\_64-win64_).
251260

252261
## 👏‍ Acknowledgements
253262

254263
* This project is inspired by another [WritingTools](https://github.com/theJayTea/WritingTools).
255-
Let's keep things simple, with Delphi.
264+
Let's keep things simple, with Delphi and Lazarus.
256265

257266
* [Super Object Toolkit](https://github.com/hgourvest/superobject) for JSON manipulation.
258267

259-
* [Markdown Processor](https://github.com/grahamegrieve/delphi-markdown) for Markdown rendering.
260-
261268
* [Prism](https://prismjs.com) for code highlighting.
262269

270+
* [Marked](https://github.com/markedjs/marked) for Markdown rendering.
271+
272+
* [MathJax](https://www.mathjax.org/) for math rendering.
273+
274+
263275
## 📄 License
264276

265277
Distributed under the MIT License.

media/demo.mp4

-89.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)