Skip to content

Commit aa01653

Browse files
author
nothing
committed
updated readme and images
1 parent 2fc5514 commit aa01653

4 files changed

Lines changed: 23 additions & 22 deletions

File tree

images/app_preview.png

-398 Bytes
Loading

images/install01.png

888 Bytes
Loading

images/uninstall.png

-527 Bytes
Loading

readme.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
![last commit](https://img.shields.io/github/last-commit/Pyenb/Keychron_software_updater)
44

5-
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.
66

77
## Table of Contents
88

99
- [Installation](#installation)
10+
- [Updating the software](#updating-the-software)
1011
- [Usage](#usage)
11-
- [Uninstallation](#uninstallation)
1212
- [Problem reports](#problem-reports)
1313
- [Anti-virus detection](#anti-virus-detection)
1414
- [FAQ](#faq)
1515
- [Thanks to](#thanks-to)
16+
- [Uninstallation](#uninstallation)
1617
- [Contributing](#contributing)
1718
- [Disclaimer](#disclaimer)
1819

@@ -25,6 +26,10 @@ This Python script automatically checks for a new version of the Keychron mice s
2526

2627
![Installation](images/install01.png)
2728

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+
2833
## Usage
2934

3035
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
3742

3843
![Update Notification](images/notification.png)
3944

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-
![preview](images/app_preview.png)
50-
![Uninstallation](images/uninstall.png)
51-
5245
## Problem reports
5346

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.
5548

5649
## Anti-virus detection
5750

5851
For information regarding anti-virus detection, please see the [av.md](av.md) file.
5952

6053
## FAQ
6154

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-
6655
**Q: Why the installer?**
6756

6857
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.
6958

70-
**Q: Why does the software need admin privileges?**
59+
**Q: Why?**
7160

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.
7362

7463
## Thanks to
7564

7665
- [wkentaro](https://github.com/wkentaro) for making [gdown](https://github.com/wkentaro/gdown)
7766
- [Keychron](https://www.keychron.com/) for making great products, even tough all my batteries are failing.
7867

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+
![preview](images/app_preview.png)
78+
![Uninstallation](images/uninstall.png)
79+
7980
## Contributing
8081

8182
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
8485

8586
## Disclaimer
8687

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.
8889

8990
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

Comments
 (0)