awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix #220 - update translate prompt README

This commit is contained in:
streetturtle 2020-12-16 20:26:58 -05:00
parent baa9177b70
commit ea9934186c
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
translate-widget/README.MD
View File

@ -1,6 +1,6 @@
# Translate Widget
This widget allows quickly translate words or phrases without opening a browser - just using Awesome. To provide direction of the translation add the 2 letters code of the source and target languages at the end of the phrase, for example _hello enfr_ will translate _hello_ from English to French. This widget is based on [Yandex.Translate API](https://tech.yandex.com/translate/).
This widget allows quickly translate words or phrases without opening a browser - just using Awesome. To provide direction of the translation add the 2 letters code of the source and target languages at the end of the phrase, for example _hello enfr_ will translate _hello_ from English to French. This widget is based on [Watson Language Translator](https://www.ibm.com/watson/services/language-translator/) from IBM.
![demo](./demo.gif)
@ -13,7 +13,8 @@ This widget allows quickly translate words or phrases without opening a browser
## Installation
1. Clone repo under **~/.config/awesome/**
1. Get an [API key](https://translate.yandex.com/developers/keys)
1. Create an IBM Cloud API key at [cloud.ibm.com/iam/apikeys](https://cloud.ibm.com/iam/apikeys)
1. Copy a service URL by going to [resource list](https://cloud.ibm.com/resources), then under "Services" select "Language Translator" option, and then copy URL from the "Credentials" section
1. Require widget in **rc.lua**:
```lua
@ -23,8 +24,15 @@ This widget allows quickly translate words or phrases without opening a browser
1. Add a shortcut to run translate prompt:
```lua
awful.key({ modkey }, "c",
function() translate.show_translate_prompt('<api-key>') end,
{ description = "run translate prompt", group = "launcher" }),
awful.key({ modkey }, "c", function()
translate.launch{api_key = '<api-key>', url = 'url'}
end, { description = "run translate prompt", group = "launcher" })
```