Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
IgKh committed Aug 24, 2024
1 parent 4a5bccd commit 6915da5
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Therefore Katvan is a new editor application, with a very specific focus on this

## Features

Not a whole lot so far, but for now we have:
Starting to get there:
- Reasonably good RTL editing
- Mostly thanks to Qt's excellent Rich Text Framework
- But also specific additional functionality, for example:
Expand All @@ -28,16 +28,15 @@ Not a whole lot so far, but for now we have:
- Syntax highlighting
- Syntax-aware spell checking
- Typical code editor niceties - auto indentation, bracket insertion, etc.
- Forward and inverse search
- [Modelines](https://github.com/IgKh/katvan/wiki/Editor-Modelines)
- Supported on Linux and Windows 10/11

[^1]: Previews are currently rendered by running the entire file through the _Typst_ CLI after each change. It is plenty fast at least for smaller documents, so good enough for now.
[^1]: Previews are currently rendered by running the entire file through the _Typst_ compiler after each change. It is plenty fast at least for smaller documents, so good enough for now.

## Installation

:warning: **IMPORTANT UPCOMING CHANGE**: Starting from the upcoming 0.7.0 release, Katvan will directly embed the Typst compiler. This will require having a Rust toolchain to build from source.

For all existing releases, it is required to install the `typst` CLI and make it available via the system path or by placing it next to the `katvan` executable. Without it previews and PDF export will not work. [See here](https://github.com/typst/typst#installation) for details.
For **versions 0.6.0 and prior** only: in addition to Katvan itself, it is required to install the `typst` CLI and make it available via the system path or by placing it next to the `katvan` executable. Without it previews and PDF export will not work. [See here](https://github.com/typst/typst#installation) for details. _This is not required for the latest release_.

### Linux

Expand All @@ -47,7 +46,7 @@ There is also an [AUR package](https://aur.archlinux.org/packages/katvan) for Ar

### Windows

A build for 64-bit Windows 10/11 is available from the project releases page. Note that this is a portable build, which will store settings and the personal dictionary file 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.
A build for 64-bit Windows 10/11 is available from the project releases page. Note that this is a portable build, which 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.

This build does not include 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.

Expand Down Expand Up @@ -85,7 +84,4 @@ Contributions aren't really expected. Issues and PRs in Github are open to creat

## Roadmap

A few things I'd like and may happen at some point, in no particular order:

- Ability to view BiDi control characters
- Forward/inverse search between editor and preview
See the dedicated [ROADMAP.md](ROADMAP.md) file.
46 changes: 46 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Feature Roadmap

Legend:

- :arrow_up: Top priority, a 1.0 release won't happen without it.
- :arrow_right: I generally want this, but probably needs more thinking about. Won't block a 1.0 release.
- :arrow_down: Maybe?

## RTL Editing

- [ ] :arrow_up: Make BiDi control characters visible in the editor with custom glyphs.
- Using a patch that will hopefully be upstreamed to Qt, but that will happen no earlier than Qt 6.9.
- [ ] :arrow_up: Make line direction overrides persistent by inserting the proper control character.
- [ ] :arrow_up: Give blank lines the base direction of the previous line, rather than the application's default.
- To avoid the Logical cursor getting stuck between two RTL paragraphs when the system language is LTR
- [ ] :arrow_right: Directionality markers on the line number gutters to improve orientation.

## Typst Integration

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

## General Editing

- [ ] :arrow_up: Make automatic backups configurable.
- [ ] :arrow_up: Use regex capture groups in text find and replace.
- [ ] :arrow_down: Outline pane.

## Platform Integrations

- [ ] :arrow_right: macOS version.
- [ ] :arrow_right: Flatpak package.
- In Flathub, and with as much sandboxing as possible.

## Sandbox Readiness

- [ ] :arrow_right: Save auto-backups in an app-local location when sandboxed.
- [ ] :arrow_down: Support a format similar to TextBundle.

## Other

- [ ] :arrow_up: User manual.

0 comments on commit 6915da5

Please sign in to comment.