diff --git a/README.md b/README.md index d69a330..5199ab4 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,11 @@ A parallel text editor using electron -## Install -Download [the latest package](https://github.com/ffreemt/ptextpad-electron/releases) and install. +## What is `ptextpad` +`ptextpad` is a parallel text editor intended for editing two texts in a two-column manner. `ptextpad` incorperates some automatic alignment engines (currently just `ezbee` and for Chinese-English texts) and `mlbee` for many many laugnage pairs. + +## Install (currently Windows 64-bit only) +Download assets from [the latest package](https://github.com/ffreemt/ptextpad-electron/releases) and install. Or from source ``` @@ -15,11 +18,14 @@ npm install # or yarn npm run dev # yarn dev ``` -## What's new -`mlbee` has been integrated into `ptextpad`. +## Usuage tips +* Double-click or press Enter to edit a cell +* Press Enter or click another cell to exit the in-cell editor +* Click SaveEdit (Ctl-E) to effect change after editing -## What is `ptextpad` -`ptextpad` is a parallel text editor intended for editing two texts in a two-column manner. `ptextpad` incorperates some automatic alignment engines (currently just `ezbee` for Chinese-English texts). +## What's new +* SaveEdit (manual editing and save) ready +* `mlbee` has been integrated into `ptextpad`. ## TODO * `ptextpad-el` currently just has `ezbee` automatic alignment support that replies on a remote server. Supports for `dzbee`, `debee` along with a possible local server are in plan phase. Installation packages for Linux/macOs will be provided later on. Stay tuned.