diff --git a/README.md b/README.md index 74004d2c..0f800162 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ /jyːt ˈdɪkʃənɛɹi/ -A program to look up words in Chinese, with Simplified Chinese, Traditional Chinese, Pinyin, Jyutping, and English input. Currently on macOS, coming in the future to Windows and Linux. +A program to look up words in Chinese, with Simplified Chinese, Traditional Chinese, Pinyin, Jyutping, and English input. Currently on macOS and Windows, coming in the future Ubuntu. [Download now!](https://github.com/aaronhktan/jyut-dict/releases) @@ -80,6 +80,11 @@ This project uses Qt 5.12. ##### Qt Creator Import the project to Qt Creator, then run. +#### Windows + +#### Qt Creator +Import the project to Qt Creator, then run. If packaging for release, select the release option in the bottom left corner of the IDE. + --- ## Packaging for release @@ -94,12 +99,22 @@ Import the project to Qt Creator, then run. - To generate the .dmg for distribution, you will need Node.js and create-dmg installed. If you do not have create-dmg installed, get it with ```npm install --global create-dmg```. - Create the dmg. ```create-dmg 'jyut-dict.app'``` +### Windows + +1. **Generate the deployment .exe**: Qt has a handy-dandy application called windeployqt that packages all the .dlls, resources and other dependencies into the same folder as the .exe. + - Run it with `windeployqt ./jyut-dict.exe` in the directory where the program was built. (Here, use the release folder.) + - Note: you may need the full path of windeployqt, and set the appropriate environment variables. Find the appropriate version by looking in the folder where you installed Qt, which on Windows may be located in the `msvc_` folder if using Microsoft Visual C++, or `mingw_64` if using MinGW/GCC for Windows. + +2. **Create a .msi file**: Windows users expect an installer that automatically places frameworks and executables in the right places, as well as setting registry keys as necessary. + - To generate the .msi for distribution, you will need Advanced Installer. + - Add the .dlls, folders, database files, and executable generated by Qt Creator and windeployqt to the list of files and folders in Advanced Installer, then click 'Build' to generate a .msi file. + --- ## On the roadmap - Include standard menu items in the macOS menu bar. - Coloured Pinyin/Jyutping characters. - La langue de la belle province. -- Windows/Ubuntu support. +- Ubuntu support. - Support for updating database independently of application. - Support for updating application.