Skip to content

Commit a85317c

Browse files
authored
refine Windows documentation (#1419)
* Mycli expects the "less" pager to be available (closes #1088). * Merge two different Windows discussions into the same section. * Remove the suggestion for Windows users to file issues, and instead say that native Windows isn't supported, which is the current practical truth. * Add a plea for Native Windows testing in CI, which would be a good first step for Windows support. * Delineate Native Windows vs WSL and nudge toward WSL.
1 parent be626f8 commit a85317c

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,22 @@ sudo dnf install mycli
105105

106106
### Windows
107107

108+
#### Option 1: Native Windows
109+
110+
Install the `less` pager, for example by `scoop install less`.
111+
108112
Follow the instructions on this blogpost: http://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
109113

114+
**Mycli is not tested on Windows**, but the libraries used in the app are Windows-compatible.
115+
This means it should work without any modifications, but isn't supported.
116+
117+
PRs to add native Windows testing to Mycli CI would be welcome!
118+
119+
#### Option 2: WSL
120+
121+
Everything should work as expected in WSL. This is a good option for using
122+
Mycli on Windows.
123+
110124

111125
### Thanks:
112126

@@ -128,9 +142,6 @@ Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure python adapte
128142

129143
Mycli is tested on macOS and Linux, and requires Python 3.10 or better.
130144

131-
**Mycli is not tested on Windows**, but the libraries used in this app are Windows-compatible.
132-
This means it should work without any modifications. If you're unable to run it
133-
on Windows, please [file a bug](https://github.com/dbcli/mycli/issues/new).
134145

135146
### Configuration and Usage
136147

changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ Features
66
* Update query processing functions to allow automatic show_warnings to work for more code paths like DDL.
77
* Rework reconnect logic to actually create a new connection instead of simply changing the database (#746).
88

9+
910
Bug Fixes
1011
--------
1112
* Update the prompt display logic to handle an edge case where a socket is used without
1213
a host being parsed from any other method (#707).
1314

1415

16+
Internal
17+
--------
18+
* Refine documentation for Windows.
19+
20+
1521
1.42.0 (2025/12/20)
1622
==============
1723

0 commit comments

Comments
 (0)