You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This Python script automatically checks for a new version of the Keychron mice software and downloads it if a new version is found.
5
+
This is a Python script, bundled into an executable, that checks for a new version of the [Keychron mice software](https://www.keychron.com/pages/learn-more-how-to-use-keychron-mouse-software) and asks the user if they want to download and install the new version. The software will automatically start on startup and check for updates.
6
6
7
7
## Table of Contents
8
8
9
9
-[Installation](#installation)
10
+
-[Updating the software](#updating-the-software)
10
11
-[Usage](#usage)
11
-
-[Uninstallation](#uninstallation)
12
12
-[Problem reports](#problem-reports)
13
13
-[Anti-virus detection](#anti-virus-detection)
14
14
-[FAQ](#faq)
15
15
-[Thanks to](#thanks-to)
16
+
-[Uninstallation](#uninstallation)
16
17
-[Contributing](#contributing)
17
18
-[Disclaimer](#disclaimer)
18
19
@@ -25,6 +26,10 @@ This Python script automatically checks for a new version of the Keychron mice s
25
26
26
27

27
28
29
+
### Updating the software
30
+
31
+
To update the updater, simply download the latest release and run the installer. The installer will automatically update the software to the latest version.
32
+
28
33
## Usage
29
34
30
35
1.**Startup**: After installation, the Keychron Software Updater will automatically check for updates to the Keychron software every time you start your computer. (Make sure to check the "Run Keychron Software Updater on startup" checkbox during installation.)
@@ -37,45 +42,41 @@ This Python script automatically checks for a new version of the Keychron mice s
37
42
38
43

39
44
40
-
## Uninstallation
41
-
42
-
To uninstall the Keychron Software Updater:
43
-
44
-
1. Open the Control Panel.
45
-
2. Click on "Uninstall a program" under Programs.
46
-
3. Find "Keychron Software Updater" in the list of installed programs and click on it.
47
-
4. Click on the "Uninstall" button that appears.
48
-
49
-

50
-

51
-
52
45
## Problem reports
53
46
54
-
The software will break if Keychron changes the download link for the software. If this happens, please open an issue with your received error message and I will try to assist you as soon as possible.
47
+
The software will break if Keychron changes the download link for the software. If this happens, please open an issue with your received error message and I will try to assist you as soon as possible. There is an issue template available to help you with the information I need to help you.
55
48
56
49
## Anti-virus detection
57
50
58
51
For information regarding anti-virus detection, please see the [av.md](av.md) file.
59
52
60
53
## FAQ
61
54
62
-
**Q: Why is the executable so big?**
63
-
64
-
A: The executable is so big because it contains the python interpreter and all the dependencies. This is because I used [PyInstaller](https://www.pyinstaller.org/) to create the executable. I am currently looking into other ways to create the executable.
65
-
66
55
**Q: Why the installer?**
67
56
68
57
A: I used [Inno Setup](https://jrsoftware.org/isinfo.php) to create the installer. This is because I wanted to make the installation process as easy as possible. Also it makes uninstalling and starting the software on startup easier.
69
58
70
-
**Q: Why does the software need admin privileges?**
59
+
**Q: Why?**
71
60
72
-
A: The official Keychron software needs the admin privileges to install their software.
61
+
A: Because Keychron's software doesn't have an auto-update feature.
73
62
74
63
## Thanks to
75
64
76
65
-[wkentaro](https://github.com/wkentaro) for making [gdown](https://github.com/wkentaro/gdown)
77
66
-[Keychron](https://www.keychron.com/) for making great products, even tough all my batteries are failing.
78
67
68
+
## Uninstallation
69
+
70
+
To uninstall the Keychron Software Updater:
71
+
72
+
1. Open the Control Panel.
73
+
2. Click on "Uninstall a program" under Programs.
74
+
3. Find "Keychron Software Updater" in the list of installed programs and click on it.
75
+
4. Click on the "Uninstall" button that appears.
76
+
77
+

78
+

79
+
79
80
## Contributing
80
81
81
82
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
@@ -84,6 +85,6 @@ Pull requests are welcome. For major changes, please open an issue first to disc
84
85
85
86
## Disclaimer
86
87
87
-
This repository is for research purposes only, the use of this code is your responsibility.
88
+
I am in no way affiliated with Keychron. This repository is for research purposes only, the use of this code is your responsibility.
88
89
89
90
I take NO responsibility and/or liability for how you choose to use any of the source code available here. By using any of the files available in this repository, you understand that you are AGREEING TO USE AT YOUR OWN RISK. Once again, ALL files available here are for EDUCATION and/or RESEARCH purposes ONLY.
0 commit comments