Skip to content

Commit 928c0e4

Browse files
committed
Update README
1 parent fcaedc5 commit 928c0e4

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Therefore Katvan is a new editor application, with a very specific focus on this
2121
- Mostly thanks to Qt's excellent Rich Text Framework
2222
- But also specific additional functionality, for example:
2323
- Syntax-aware line directionality heuristc
24+
- Automatic directionality isolation of inline math and code
2425
- Toggling between logical and visual cursor movement
2526
- Manually flipping paragraph direction (using both Windows style `Ctrl+RShift`/`LShift`, or Firefox style `Ctrl+Shift+X`)
2627
- Handy commands to insert BiDi control marks and isolates for when the algorithm doesn't quite lead to the right result (e.g. for inline math)
@@ -46,9 +47,9 @@ There is also an [AUR package](https://aur.archlinux.org/packages/katvan) for Ar
4647

4748
### Windows
4849

49-
Builds for 64-bit Windows 10/11 are available from the project releases page. There is a traditional installer, as well as a portable build. The portable build will store settings, the personal dictionary file and the cache for downloaded Universe packages in the same directory as the main executable, so make sure to extract the archive in a writable location. To write settings to the registry instead, run the `katvan.exe` binary with the `--no-portable` flag.
50+
Builds for 64-bit Windows 10/11 are available from the project releases page. There is a traditional installer, as well as a portable build. The portable build will store settings and the cache for downloaded Universe packages in the same directory as the main executable, so make sure to extract the archive in a writable location. To write settings to the registry instead, run the `katvan.exe` binary with the `--no-portable` flag.
5051

51-
Neither build includes spell checking dictionaries. You'll need to download hunsepll dictionaries for any desired languages (as a pair of `.dic` and `.aff` files), and save them to the `hunspell` sub-directory next to the main executable file. See the hunspell [README](https://github.com/hunspell/hunspell?tab=readme-ov-file#dictionaries) page for locations to get dictionaries from.
52+
Both builds use the built-in Windows spell checker, and will therefore make use of the language packs available on the host.
5253

5354
### macOS
5455

@@ -63,7 +64,7 @@ To compile and install Katvan from source code, you'll need:
6364
- CMake 3.19 or later
6465
- [Corrosion](https://github.com/corrosion-rs/corrosion) (optional, will be automatically downloaded if missing)
6566
- A working `pkg-config`
66-
- [hunspell](http://hunspell.github.io/) (not required on macOS)
67+
- [hunspell](http://hunspell.github.io/) (required only on Linux)
6768
- [libarchive](https://libarchive.org/)
6869
- [GoogleTest](https://google.github.io/googletest/) (optional, for running unit tests)
6970

ROADMAP.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Legend:
1919

2020
- [ ] :arrow_up: True live preview.
2121
- [X] :arrow_up: Configuration panel for monitoring and pruning download cache.
22-
- [ ] :arrow_right: Highlight errors directly on the editor.
22+
- [X] :arrow_right: Highlight errors directly on the editor.
2323
- [ ] :arrow_right: Auto-complete.
24-
- [ ] :arrow_right: Compiler-assisted tool tips.
24+
- [X] :arrow_right: Compiler-assisted tool tips.
2525
- [ ] :arrow_right: Go to definition (as long as it is in the same file).
2626

2727
## General Editing

0 commit comments

Comments
 (0)