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

docs: mention file type configuration in README.md and help.md

Browse source 
closes #192
This commit is contained in:
CJ van den Berg 2025-07-14 17:54:50 +02:00
parent a540d2bf36
commit af22eb4be6
Signed by: neurocyte
GPG key ID: 8EB1E1BB660E3FB9
2 changed files with 33 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -94,14 +94,6 @@ You may install it on another system by simply copying the binary.
scp zig-out/bin/flow root@otherhost:/usr/local/bin
```
Configuration is mostly dynamically maintained with various commands in the UI.
It is stored under the standard user configuration path. Usually `~/.config/flow`
on Linux. %APPDATA%\Roaming\flow on Windows. Somewhere magical on MacOS
Logs, traces and per-project most recently used file lists are stored in the
standard user application state directory. Usually `~/.local/state/flow` on
Linux and %APPDATA%\Roaming\flow on Windows.
Files to load may be specifed on the command line:
```shell
@ -133,9 +125,26 @@ Show supported language names with `--list-languages`.
See `flow --help` for the full list of command line options.
# Configuration
Configuration is mostly dynamically maintained with various commands in the UI.
It is stored under the standard user configuration path. Usually `~/.config/flow`
on Linux. %APPDATA%\Roaming\flow on Windows. Somewhere magical on MacOS.
There are commands to open the various configuration files, so you don't have to
manually find them. Look for commands starting with `Edit` in the command palette.
File types may be configured with the `Edit file type configuration` command. You
can also create a new file type by adding a new `.conf` file to the `file_type`
directory. Have a look at an existing file type to see what options are available.
Logs, traces and per-project most recently used file lists are stored in the
standard user application state directory. Usually `~/.local/state/flow` on
Linux and %APPDATA%\Roaming\flow on Windows.
# Key bindings and commands
Press `F2` to switch the current keybinding mode. (flow, vim, emacs, etc.)
Press `F4` to switch the current keybinding mode. (flow, vim, emacs, etc.)
Press `ctrl+shift+p` or `alt+x` to show the command palette.
Press `ctrl+F2` to see a full list of all current keybindings and commands.

28
help.md
View file

@ -157,19 +157,17 @@ Configuration is stored in the standard location
The default configuration will be written the first time
Flow Control is started and looks similar to this:
```
{
"frame_rate": 60,
"theme": "default",
"input_mode": "flow",
"gutter_line_numbers": true,
"gutter_line_numbers_relative": false,
"enable_terminal_cursor": false,
"highlight_current_line": true,
"highlight_current_line_gutter": true,
"show_whitespace": false,
"animation_min_lag": 0,
"animation_max_lag": 150
}
frame_rate 60
theme "default"
input_mode "flow"
gutter_line_numbers true
gutter_line_numbers_relative false
enable_terminal_cursor false
highlight_current_line true
highlight_current_line_gutter true
show_whitespace false
animation_min_lag 0
animation_max_lag 150
```
Most of these options are fairly self explanitory.
@ -183,3 +181,7 @@ of frames rendered.
`animation_max_lag` controls the maximum amount of time allowed
for rendering scrolling animations. Set to 0 to disable scrolling
animation altogether.
File types may be configured with the `Edit file type configuration` command. You
can also create a new file type by adding a new `.conf` file to the `file_type`
directory. Have a look at an existing file type to see what options are available.