Skip to content

Commit

Permalink
doc(README): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mistgc committed Feb 14, 2024
1 parent 6fb3d68 commit f4facc6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ copy-command = "wl-copy"
annotation-size-factor = 2
# Filename to use for saving action. Omit to disable saving to file. Might contain format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime/index.html
output-filename = "/tmp/test-%Y-%m-%d_%H:%M:%S.png"
# Hide toolbars by default
default-hide-toolbars = false

# custom colours for the colour palette
[color-palette]
Expand Down Expand Up @@ -96,7 +98,7 @@ Options:
--fullscreen
Start Satty in fullscreen mode
--output-filename <OUTPUT_FILENAME>
Filename to use for saving action. Omit to disable saving to file. Might contain format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime/index.html
Filename to use for saving action. Omit to disable saving to file. Might contain format specifiers: <https://docs.rs/chrono/latest/chrono/format/strftime/index.html>
--early-exit
Exit directly after copy/save action
--initial-tool <TOOL>
Expand All @@ -105,6 +107,8 @@ Options:
Configure the command to be called on copy, for example `wl-copy`
--annotation-size-factor <ANNOTATION_SIZE_FACTOR>
Increase or decrease the size of the annotations
-d, --default-hide-toolbars
Hide toolbars by default
-h, --help
Print help
-V, --version
Expand Down
2 changes: 2 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ copy-command = "wl-copy"
annotation-size-factor = 2
# Filename to use for saving action. Omit to disable saving to file. Might contain format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime/index.html
output-filename = "/tmp/test-%Y-%m-%d_%H:%M:%S.png"
# Hide toolbars by default
dafault-hide-toolbars = false

# custom colours for the colour palette
[color-palette]
Expand Down

0 comments on commit f4facc6

Please sign in to comment.