neurocyte/flow
neurocyte/flow
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
CJ van den Berg 2024-02-29 17:28:41 +01:00 • committed by GitHub
parent 987b4dab9a
commit 71005db0da
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -5,13 +5,18 @@ This is my Zig text editor. It is very much a work-in-progress, but far enough a
https://github.com/neurocyte/flow/assets/1552770/97aae817-c209-4c08-bc65-0a0bf1f2d4c6 https://github.com/neurocyte/flow/assets/1552770/97aae817-c209-4c08-bc65-0a0bf1f2d4c6
# Building
Build with the provided zig wrapper: Build with the provided zig wrapper:
```shell ```shell
./zig build -Doptimize=ReleaseFast ./zig build -Doptimize=ReleaseFast
``` ```
The zig wrapper just fetches a known good version of zig nightly and places it The zig wrapper just fetches a known good version of zig nightly and places it
in the .cache directory. Or use your own version of zig. in the .cache directory. Or use your own version of zig. Be sure to use a version
at least as high as the version used be the zig wrapper. It's stored in `build.zig.version`.
Also, make sure your system meets the requirements listed below.
Run with: Run with:
```shell ```shell
@ -22,13 +27,13 @@ Place it in your path for convenient access.
See --help for full command line. See --help for full command line.
requirements: # Requirements
- A modern terminal with 24bit color and kitty keyboard protocol support (kitty and ghostty are the only recommended terminals at this time) - A modern terminal with 24bit color and kitty keyboard protocol support (kitty and ghostty are the only recommended terminals at this time)
- NerdFonts support - NerdFonts support
- Linux or MacOS (help porting to *BSD or Windows is welcome!) - Linux or MacOS (help porting to *BSD or Windows is welcome!)
- A UTF-8 locale (very important!) - A UTF-8 locale (very important!)
features: # Features
- fast TUI interface. no user interaction should take longer than one frame (6ms) (even debug builds) - fast TUI interface. no user interaction should take longer than one frame (6ms) (even debug builds)
- tree sitter based syntax highlighting - tree sitter based syntax highlighting
- multi cursor editing support - multi cursor editing support
@ -41,7 +46,7 @@ features:
- infinite undo/redo (at least until you run out of ram) - infinite undo/redo (at least until you run out of ram)
- stuff I've forgotten to mention... - stuff I've forgotten to mention...
features in progress: # Features in progress
- LSP support for linting and navigating - LSP support for linting and navigating
- find in files - find in files
- multi tty support (shared editor sessions across multiple ttys) - multi tty support (shared editor sessions across multiple ttys)
@ -49,6 +54,6 @@ features in progress:
- completion UI - completion UI
- persistent undo/redo - persistent undo/redo
features planned: # Features planned for the future
- multi host editing - multi host editing
- multi user editing - multi user editing