summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorAdrien Hopkins <adrien.p.hopkins@gmail.com>2019-04-14 17:41:10 -0400
committerAdrien Hopkins <adrien.p.hopkins@gmail.com>2019-04-14 17:41:10 -0400
commitb43c399c21bddd3cb8af42c109940564c3890cf7 (patch)
tree231fcb8f72a467a77efc1e6050de12bd70f7b152 /README.org
parent73d305684d3549d17ebd95a5fdb7d366849db226 (diff)
Bumped the version number to v0.2.0
Diffstat (limited to 'README.org')
-rw-r--r--README.org23
1 files changed, 13 insertions, 10 deletions
diff --git a/README.org b/README.org
index 5500d68..2a6fa95 100644
--- a/README.org
+++ b/README.org
@@ -1,25 +1,27 @@
-* What is it?
+* Unit Converter v0.2.0
+(this project uses Semantic Versioning)
+** What is it?
This is a unit converter, which allows you to convert between different units, and includes a GUI which can read unit data from a file (using some unit math) and convert between units that you type in, and has a unit and prefix viewer to check the units that have been loaded in.
-* Features
+** Features
- Convert between units and expressions of units
- linear or base unit can use unit prefixes (including non-metric units!)
- and prefixes are defined in an editable data file, in a simple and intuitive format.
- Viewer and Prefix Viewer which allow you to search through all of the available units and prefixes and learn details about them.
- All of SI included in default text file
- Choose your precision
-* How to Convert (in "Convert Units")
+** How to Convert (in "Convert Units")
To convert units, simply:
1. Select the kind of units to convert (length/mass/time, etc.).
2. Select the units to convert from and to (you can use the text boxes above to search)
3. Enter a value to convert
4. Press "Convert"
-* How to Convert (in "Convert Expressions")
+** How to Convert (in "Convert Expressions")
To convert units, simply enter the first unit in the From box and the second unit in the To box. Press Convert and a result will appear in the output box. Both boxes accept unit expressions, so you can input things like ‘1.7 m’, ‘85 km/h’ and ‘35 A * 14 s’ into either box.
*Warning*: The space between the number and the unit name is required, or else the whole expression will be interpreted as a unit name. Spaces are not required for operators.
Use the slider at the bottom to choose the maximum precision of the result, in significant digits, not decimal places.
-* Units Files and Expressions
+** Units Files and Expressions
As mentioned previously, all units are loaded from a units file. The format for lines consists of a name for the unit, some tabs (not spaces), and an expression. The following operations are supported in expressions:
- Addition using the plus sign (+), which only works on compatible units
- Subtraction using the minus sign (-), which only works on compatible units
@@ -44,14 +46,14 @@ Unit prefixes are defined differently. When a unit name ends with the dash (-)
- Division using the forward slash (/)
- Exponentiation using the caret (^)
Every argument can be a number or a prefix name, except exponents which much be integers
-* Unit Prefixes
+** Unit Prefixes
In SI, you can have a unit prefix, which you attach to the start of a unit and it multiplies the unit by a certain value. For example, milli-metre = 0.001 * metre. This unit converter supports unit prefixes, and you can put any number of prefixes before a linear or base unit to transform it (this includes non-SI units).
You can use more than one prefix at once (yottayottametre = really really long distance), but you may not convert prefixes alone. If you want to do that, use ‘unit’ or ‘u’ (ku = 1000000 mu). You can also use u for converting from numbers (pi = 3.141593 u).
The default unit file allows you to use D-, H- and K- in place of da-, h- and k- if you want.
*Warning*: The standard prefixes will never use 1024 instead of 1000, even when operating on bits and bytes. Use ‘Ki’, ‘Mi’, ‘Gi’, ‘Ti’ and so on instead.
-* Nonlinear Units
+** Nonlinear Units
Sometimes, units cannot be converted from and to by simply multiplying and dividing. A common example of this is the Celsius and Fahrenheit temperature scales, which require multiplication and addition to convert to each other (and to their base, Kelvin).
To use nonlinear units, use the following syntax:
@@ -64,9 +66,9 @@ Nonlinear units cannot:
- be defined by unit files
To define a nonlinear unit, make an anonymous inner type (or any other subclass) of AbstractUnit, and define the conversion methods.
-* Unit and Prefix Viewers
+** Unit and Prefix Viewers
The unit and prefix viewers can be used to see the available units (without prefixes) and prefixes. Upon opening them, you will see a list of units or prefixes on your left. Using the text box above, the list can be filtered. When a unit is clicked on, details about will be displayed on the right.
-* Copyright and Licences
+** Copyright and Licences
The Unit Converter program is Copyright (C) 2018, 2019 Adrien Hopkins. It is released under the terms of the Aferro GNU General Public License, version 3.0 or any later version published by the Free Software Foundation. A copy of this license should be provided with this program, and a human-readable summary of the very similar GNU General Public License can be found at the following link: https://www.gnu.org/licenses/quick-guide-gplv3.html, although this summary is NOT a replacement for the actual license.
This document is Copyright (C) 2019 Adrien Hopkins. This document is dual-licensed under the terms of the GNU Free Documentation License and the Creative Commons Attribution-ShareAlike License. More details are in the next paragraphs:
@@ -74,7 +76,7 @@ This document is Copyright (C) 2019 Adrien Hopkins. This document is dual-licen
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
-** GNU Free Documentation License
+*** GNU Free Documentation License
GNU Free Documentation License
Version 1.3, 3 November 2008
@@ -526,3 +528,4 @@ If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
+