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

Update README.md to move requirements section to the top

Browse source
This commit is contained in:
CJ van den Berg 2024-03-01 16:05:45 +01:00 • committed by GitHub
parent 980411f42d
commit daaa524088
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -5,9 +5,15 @@ 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
# Requirements
- A modern terminal with 24bit color and kitty keyboard protocol support (kitty and ghostty are the only recommended terminals at this time)
- NerdFonts support
- Linux or MacOS (help porting to *BSD or Windows is welcome!)
- A UTF-8 locale (very important!)
# Building # Building
Make sure your system meets the requirements listed below. Make sure your system meets the requirements listed above.
Flow tracks zig master most of the time. Build with: Flow tracks zig master most of the time. Build with:
@ -39,7 +45,7 @@ See --help for full command line.
## MacOS ## MacOS
On MacOS you will need to link Flow against a MacOS build of notcurses 3.0.9. This On MacOS you will need to link Flow against a MacOS build of **notcurses 3.0.9**. This
is easiest with `brew`: is easiest with `brew`:
```shell ```shell
@ -60,12 +66,6 @@ kitty_mod ctrl+alt
For Ghostty each conflicting binding has to be reconfigured individually. For Ghostty each conflicting binding has to be reconfigured individually.
# Requirements
- A modern terminal with 24bit color and kitty keyboard protocol support (kitty and ghostty are the only recommended terminals at this time)
- NerdFonts support
- Linux or MacOS (help porting to *BSD or Windows is welcome!)
- 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