Skip to content

Commit

Permalink
added some missing info in README and BUGS
Browse files Browse the repository at this point in the history
  • Loading branch information
EliahKagan committed Aug 15, 2021
1 parent 2d0eae5 commit 41cea36
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
13 changes: 12 additions & 1 deletion BUGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ color.)

## UI/Features

### Neighbor enumeration strategies don’t scroll before Windows 10.

On Windows 8.1 and earlier—and on Windows 10 if “Scroll inactive
windows when I hover over them” has been turned off—the neighbor
enumeration strategy (and sub-strategies) cannot be adjusted, hugely
diminishing the program’s functionality.

This bug exists because I forgot that, unlike many other OSes, Windows has not
always allowed inactive windows to be scrolled with the mouse wheel. I think it
should be fairly easy to fix.

### The UI is confusing.

People who’ve tried out this program could not immediately tell how to
Expand Down Expand Up @@ -97,7 +108,7 @@ supplied by a library, being present as a separate assembly from the query
assembly) and calling the `Activate` method.

The comment gives details about why I don”t think any currently available
good means of doing this exist. But as long as I’m doin that, Flood
good means of doing this exist. But as long as I’m doing that, Flood
cannot have a stable release, as `OutputPanel.Activate` has the `internal`
access modifier and it may be removed, or change behavior, in any future
version of LINQPad.
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ far from universal.

This README file provides only condensed documentation. For more documentation,
including detailed usage guidance and implementation notes, please see the full
help, `doc/help.html`, which can also be viewed in
Flood’s built-in help browser.
help, `doc/help.html`, which can also be viewed in Flood’s built-in help
browser [or visited online](https://eliahkagan.github.io/Flood/doc/help.html).

When running Flood, you can also click the *Show Tips* button to open brief
help, which I recommend. The tips are presented in condensed, tabular form.
Expand All @@ -72,8 +72,9 @@ information, and clicking on an item opens (or switches to) the built-in help
browser, scrolling to the relevant section of the help and highlighting the
specific relevant part.

The tips can also be browsed by going to `doc/tips.html` in a web browser. When
viewed that way, the items behave as ordinary hyperlinks into `doc/help.html`.
The tips can also be browsed by going to `doc/tips.html` in a web browser,
locally [or on the web](https://eliahkagan.github.io/Flood/doc/tips.html). When
viewed that way, the items behave as ordinary hyperlinks into the full help.

## License

Expand Down Expand Up @@ -105,7 +106,7 @@ copyright/licensing information.
I’d like to thank:

- David Vassallo, for testing the program and giving usability feedback.
- Another user, for testing the program and giving usability feedback, and
- Thomas Fallon, for testing the program and giving usability feedback, and
finding a severe performance bug.
- [Zanna Star](https://github.com/ZannaStar), for examining and giving advice
about how to improve the presentation and styling for `help.html`. It was
Expand Down

0 comments on commit 41cea36

Please sign in to comment.