Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor carry timeout, formula letters, fixes and doc nitpicks #10

Open
wants to merge 11 commits into
base: maccel-dev
Choose a base branch
from
Open

Minor carry timeout, formula letters, fixes and doc nitpicks #10

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
39c6a97
doc(maccel) explain Debug-enable sample code
ankostis Mar 10, 2024
51f1691
doc(maccel) explain why low DPIs need throttling >
ankostis Mar 10, 2024
6f56b7b
doc(maccel) denote letter-symbols & and desmos on sample params
ankostis Mar 2, 2024
b8662f3
feat(maccel) stabilize debug print float widths
ankostis Mar 2, 2024
ec76f8b
feat(maccel) debug-dump V as diffs to view carry at work and >
ankostis Mar 2, 2024
9f9693b
fix(maccel) don't dump param-keys if DEBUG is off
ankostis Mar 4, 2024
e8c6d29
feat(maccel) don's reset rounding carry if not stationary
ankostis Mar 3, 2024
1d285de
refact(maccel) demote timer from module-static -> function, >
ankostis Mar 11, 2024
0817331
refact(maccel) explain x1000 factor as curve-fitting, >
ankostis Mar 12, 2024
e164bc3
feat(maccel) debug-dump D as diffs to hook the eye on 0s
ankostis Mar 12, 2024
426ba61
style(maccel) minor comment move
ankostis Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions maccel/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,13 @@ A good starting point for tweaking your settings, is to set your default DPI sli

**Debug console**: To aid in dialing in your settings just right, a debug mode exists to print mathy details to the console. The debug console will print your current DPI setting and variable settings, as well as the acceleration factor, the input and output velocity, and the input and output distance. Refer to the QMK documentation on how to *enable the console and debugging*, then enable mouse acceleration debugging in `config.h`:
```c
#define MACCEL_DEBUG
/*
* Requires enabling float support for printf!
/**
* To view mouse's distance/velocity and curve parameters while configuring maccel,
* set `CONSOLE_ENABLE = yes` in `rules.mk`, uncomment the lines below,
* and run `qmk console` in the shell.
* Note: requires enabling float support for printf!
*/
#define MACCEL_DEBUG
Comment on lines 108 to +115
Copy link
Owner

@burkfers burkfers Mar 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quote @Wimads:

Explain debug: accept with change. I agree that the little extra explanation is useful. Would add that explanation outside the code block though.

Agreed, it's a good change, but for legibility, please place the text before the code block.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean not to be included in the user's config file?

My purpose was exactly that. for the user to view in his/her file the instructions to enable logging.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a good point! Placing it in the code block encourages the user to place these instructions in their config, for easy context later down the road.
I'm convinced.

@Wimads?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, I guess that makes some kind of sense. But it also feels weird to have the readme explain one part in the text, and then have the rest of the explanation in the code block :P But do as you see fit, no strong opinion from my side.

#undef PRINTF_SUPPORT_DECIMAL_SPECIFIERS
#define PRINTF_SUPPORT_DECIMAL_SPECIFIERS 1
```
Expand Down