Skip to content

Commit e27749d

Browse files
committed
docs: update outdated entry in BUGS.md, cleanup README.md a bit more
1 parent 4629413 commit e27749d

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,7 @@ cargo install --path .
9393
- Play/Pause
9494
- Seek 5 seconds forward/backward
9595
- Media keys Play/Pause support via MPRIS in Linux
96-
- 🚧 There's a bug in this feature at the moment: ownership of the media keys is lost when some other application overtakes it,
97-
and not regained afterwards. The UX for this case is generally weird in all applications, though. I'm not sure what UX
98-
I'd prefer myself, even. But, at the very least, it should be regained when the overtaking application is closed (such as a Google Chrome
99-
tab being opened to YouTube overtaking it, but it being regained when the tab is closed).
10096
- Help Screen
101-
- 🚧 This is pretty raw, right now. The goal is for Jolteon to require no guesswork, no external documentation, and to feel 100% friendly and risk-free.
102-
(no destructive actions, Ctrl+Z for everything, no confusing behavior, etc).
10397
- Focus on stability
10498
- Application crashes are handled safely, restoring the terminal to its normal state before exiting the process.
10599
- Thread hygiene: all threads joined on exit - no thread is brute-force-killed by the OS on process exit.
@@ -108,9 +102,12 @@ cargo install --path .
108102
- 🚧 In the future, if any non-bug causes an issue, rather than just being ignored, proper UX will be implemented and feedback given.
109103
- A clock on the top bar. Can be turned off via configuration.
110104
- Configurable key bindings
111-
- The Help screen has a bit of info on this, but the UX will improve in the future, like support to change the key bindings inside the application.
105+
- See [actions.ini](assets/actions.ini) — the default key bindings.
106+
- Or run `jolteon print-default-key-bindings`.
107+
- Can also `jolteon print-default-key-bindings > ~/.config/jolteon/actions.ini` to get started.
108+
- The Help screen has a bit of info on this, too, but the UX will improve in the future, like support to change the key bindings inside the application.
112109
- 🚧 Themes
113-
- Currently, there's only one theme. You can find it in `assets/theme.toml`. 90% of the code allowing customization and multiple
110+
- Currently, there's only one theme. You can find it in `assets/gruvbox_dark.toml`. 90% of the code allowing customization and multiple
114111
out-of-the-box themes is already done, so this feature is likely to come soon.
115112
- There will be some way to switch themes programmatically from outside the application, for themes to be switchable by external scripts.
116113
- Integration with OS light/dark mode will be added. Which theme is associated with each mode will be configurable, but have a sensible default.

docs/BUGS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ It'd be nice to reuse most of the existing library code for the cache. It's prac
4343
When using search, the view isn't scrolled to show the selected element after modifying the filter (meaning: pressing letter or number keys).
4444
It is correctly scrolled when navigating the search matches with the arrow keys.
4545

46-
This happens in the Artist/Album Tree in the Library, too, but this component hasn't been replaced by the generic List component yet,
47-
and it lacks some features it has, so there's no sense in fixing it there. It just needs to be replaced by the generic list component,
48-
but the list component needs to be enhanced before that can happen, to support a "tree" view.
46+
This is fixed in the Artist/Album Tree in the Library.
47+
48+
I will probably replace the List with a Tree of nodes without children (depth=1).
4949

5050
## High CPU Usage (in rare case)
5151

0 commit comments

Comments
 (0)