Skip to content

Commit

Permalink
Merge pull request #6 from deefrawley/deefrawley_fullhints
Browse files Browse the repository at this point in the history
Improve user experience
  • Loading branch information
deefrawley authored Sep 9, 2021
2 parents 797426d + 76e0df4 commit f5b5a81
Show file tree
Hide file tree
Showing 16 changed files with 1,105 additions and 168 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

### Project Specific ###
scratch.py
app.xcf

### Python ###
# Byte-compiled / optimized / DLL files
Expand Down
6 changes: 6 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Graduated Cylinder icon by AS Design from the Noun Project
area icon by matteo manenti from the Noun Project
distance icon by Anthony Ledoux from the Noun Project
Weight icon by Adrien Coquet from the Noun Project
Temperature icon by Alexander Skowalsky from the Noun Project
77 changes: 61 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# General Converter (Flow.Launcher.GenConvert)

General weight, distance, area, temperature converter for the [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher)
General weight, volume, distance, area, temperature converter for the [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher)

### About

### Requirements

Python 3.5 or later installed on your system, with python.exe in your PATH variable and this path updated in the Flow Launcher settings (this is a general requirement to use Python plugins with Flow). As of v1.8, Flow Launcher should take care of the installation of Python for you if it is not on your system.
Python 3.5 or later. As of Flow Launcher v1.8, Flow should take care of the installation of Python for you if it is not on your system.

### Installing

Expand All @@ -26,8 +27,11 @@ Currently English and Chinese language supported. Edit the .env file to change t

| Keyword | Description |
| ----------------------------------- | -------------------------------------------------- |
| `gc <amount> <from unit> <to unit>` | Convert the amount of the from unit to the to unit |
| `gc <amount> <from unit> <to unit>` | Convert the amount of the from unit to the to unit. |

Just entering the keyword will give you the full list of units to choose from in Flow.

Entering the keyword, amount and from unit will give you a subset list of units the from unit can be converted to
#### Units

The following units and their abbreviations can be used (each table can only convert among its' own units):
Expand All @@ -37,12 +41,13 @@ The following units and their abbreviations can be used (each table can only con
<th>Subject</th>
<th>Unit</th>
<th>Abbreviation</th>
<th rowspan="9" align="center"><img src="assets/Distance.ico" alt="Distance Logo"></th>
</tr>
<tr>
<td rowspan="8" align="center">Distance</td>
<td rowspan="8" align="center"> Distance</td>
<td>millimetre</td>
<td>mm</td>
</tr>
</tr>
<tr>
<td>centimetre</td>
<td>cm</td>
Expand Down Expand Up @@ -78,43 +83,76 @@ The following units and their abbreviations can be used (each table can only con
<th>Subject</th>
<th>Unit</th>
<th>Abbreviation</th>
<th rowspan="189" align="center"><img src="assets/Volume.ico" alt="Volume Logo"></th>
</tr>
<tr>
<td rowspan="9" align="center">Fluids</td>
<td rowspan="17" align="center">Volume</td>
<td>millilitre</td>
<td>ml</td>
</tr>
</tr>
<tr>
<td>gram</td>
<td>gm</td>
</tr>
<tr>
<td>litre</td>
<td>l</td>
</tr>
<tr>
<td>pint</td>
<td>pint US</td>
<td>pt</td>
</tr>
<tr>
<td>quart</td>
<td>pint Imperial</td>
<td>ptimp</td>
</tr>
<tr>
<td>quart US</td>
<td>qt</td>
</tr>
<tr>
<td>cup</td>
<td>quart Imperial</td>
<td>qtimp</td>
</tr>
<tr>
<td>cup US</td>
<td>cup</td>
</tr>
<tr>
<td>teaspoon</td>
<td>cup Imperial</td>
<td>cupimp</td>
</tr>
<tr>
<td>teaspoon US</td>
<td>tsp</td>
</tr>
<tr>
<td>tablespoon</td>
<td>teaspoon Imperial</td>
<td>tspimp</td>
</tr>
<tr>
<td>tablespoon US</td>
<td>tbsp</td>
</tr>
<tr>
<td>gallon</td>
<td>tablespoon Imperial</td>
<td>tbspimp</td>
</tr>
<tr>
<td>gallon US</td>
<td>gal</td>
</tr>
<tr>
<td>gram</td>
<td>gm</td>
<td>gallon Imperial</td>
<td>galimp</td>
</tr>
<tr>
<td>fluid ounce US</td>
<td>floz</td>
</tr>
<tr>
<td>fluid ounce Imperial</td>
<td>flozimp</td>
</tr>
</table>

Expand All @@ -123,6 +161,7 @@ The following units and their abbreviations can be used (each table can only con
<th>Subject</th>
<th>Unit</th>
<th>Abbreviation</th>
<th rowspan="10" align="center"><img src="assets/Area.ico" alt="Area Logo"></th>
</tr>
<tr>
<td rowspan="9" align="center">Area</td>
Expand Down Expand Up @@ -168,6 +207,7 @@ The following units and their abbreviations can be used (each table can only con
<th>Subject</th>
<th>Unit</th>
<th>Abbreviation</th>
<th rowspan="7" align="center"><img src="assets/Weight.ico" alt="Weight Logo"></th>
</tr>
<tr>
<td rowspan="6" align="center">Weight</td>
Expand Down Expand Up @@ -201,16 +241,21 @@ The following units and their abbreviations can be used (each table can only con
<th>Subject</th>
<th>Unit</th>
<th>Abbreviation</th>
<th rowspan="4" align="center"><img src="assets/Temperature.ico" alt="Temperature Logo"></th>
</tr>
<tr>
<td rowspan = "2" align="center">Temperature</td>
<td rowspan = "3" align="center">Temperature</td>
<td>celsius</td>
<td>c</td>
</tr>
<tr>
<td>Farenheit</td>
<td>f</td>
</tr>
<tr>
<td>Kelvin</td>
<td>k</td>
</tr>
</table>

### Problems, errors and feature requests
Expand Down
Binary file added assets/Area.ico
Binary file not shown.
Binary file added assets/Distance.ico
Binary file not shown.
Binary file added assets/Temperature.ico
Binary file not shown.
Binary file added assets/Volume.ico
Binary file not shown.
Binary file added assets/Weight.ico
Binary file not shown.
2 changes: 1 addition & 1 deletion plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"Name": "General Converter",
"Description": "General weights and measures converter",
"Author": "deefrawley",
"Version": "1.0.2",
"Version": "1.1.0",
"Language": "python",
"Website": "https://github.com/deefrawley/Flow.Launcher.Plugin.GenConvert",
"IcoPath": "assets/favicon.ico",
Expand Down
Binary file modified plugin/translations/en/LC_MESSAGES/messages.mo
Binary file not shown.
Loading

0 comments on commit f5b5a81

Please sign in to comment.