diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ee269c..e879827 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,34 +2,42 @@ CHANGELOG --------- All notable changes to this project will be documented on this file. +**Patch 1.3** + +_Release date: TBA_ + +* Things to do + - [ ] UI: make it run in the system tray + + **Patch 1.2** _Release date: 1 Sep 2018_ -* What's new +* What's new? * Gestures and Meaning column can now be sorted + * _Remove_ button can now delete a selected gesture + +* UI + * Added a shiny icon + +* Bug Fixes + * Fixed the 'left alt' ValueError + * Fixed a bug wherein updated gesture or meaning are not updated correctly + * Fixed a bug wherein the user can still add an existing gesture + +* Shortcut + * Added 'Ctrl+Q' to quit the app + +* Backend (the bloody part) + * Remove usage of PyAutoGui which was a workaround for the '?' not typing properly + * Settings are now updated for every add, update or remove * Upgrade - * Updated _keyboard_ 0.13.2 + * Updated _keyboard_ to 0.13.2 * Updated _PyQt_ to 5.11.2 * Updated _Python_ to 3.6.6 -* Things to do - - [x] QUESTION MARK: remove pyautogui implementation - - [x] TOOLS: update to latest versions (keyboard, Python, PyQt) - - [x] SHORTCUT: add 'Ctrl+Q' to quit the app - - [x] BUG: fix left alt value error - - [ ] UI: make it run in the system tray - - [x] UI: find a suitable icon - - [x] IMPROVEMENT: self.settings should be updated on the go - - [x] FEEDBACK: auto-sort when gestures are updated - - [x] REMOVE BUTTON: disable and enable when a gesture in the Gesture column is selected (2) should not ask what gesture to delete - - [x] REMOVE BUTTON: self-destruct when no existing gestures is remove - - [x] UPDATE: not reflecting after updating either gesture or meaning - - [x] GESTURESTABLE: should retain the previous value of the cell editing - - [x] GESTURESTABLE: get selectedData via using the arrow keys - - [x] ADD BUTTON: you can still add existing gestures - **Patch 1.1.1** diff --git a/README.md b/README.md index 76a9be2..ab8969f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**Gestures** +![Hey! Gestures](images/g-key-32.png) **Gestures** --- An application for people who just loved to type. @@ -6,3 +6,33 @@ Feature(s) --- * Abbreviate commonly typed phrases such as passwords, emails, numbers, etc. * Open favorite websites by a simple key press on the keyboard + +Usage +--- +***Adding a gesture*** +1. Press the Add button +2. Enter the gesture and its equivalent meaning, then hit OK +3. Type the gesture + `space` and the meaning will be type written + +***Updating a gesture*** + +There are two ways to update a gesture via double-clicking the cell or using the `Update` button: + +_Via double-click_ +1. Double-click the cell you want to update either gesture or meaning. +2. Press `Enter` to accept your amendments + +_Via `Update` button_ +1. Press the `Update` button +2. Type the gesture and its new meaning, then hit OK + +Note: The `Update` button will only update the meaning of the gesture. If you want to update the gesture, use the first method. + +***Removing a gesture*** +1. Click on the row you want to remove +2. Press the `Remove` button and it will be remove instantly + +Credits +--- +* Arnaud Nelissen aka [Chromatix](http://www.iconarchive.com/artist/chromatix.html) for the beautiful icon use by Gestures +* [keyboard](https://github.com/boppreh/keyboard) the core library which inspired me to create Gestures