diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 45 |
1 files changed, 31 insertions, 14 deletions
@@ -1,18 +1,35 @@ -* 7Units Version 0.5.0 - (this project uses Semantic Versioning) +* 7Units Version 1.0.0 +This project uses Semantic Versioning, and its public API is all public code in ~src/main/java~. + +[[http://unmaintained.tech/][http://unmaintained.tech/badge.svg]] ** 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. +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. + +7Units started as a high school project, but over my bachelor's degree I continued working on it from time to time to perfect it. - Check the [[./docs/manual.pdf][user manual]] for information on how to use the program. +Check the [[./docs/manual.pdf][user manual]] for information on how to use the program. ** Features - - Convert between units and between expressions of units - - Any linear or base units can use unit prefixes (including non-metric units!) - - 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 - - Customizable rounding rules +- Convert between units and between expressions of units +- Any linear or base units can use unit prefixes (including non-metric units!) +- 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 +- Customizable rounding rules +- Multiple languages, with ability to add additional custom language files ** Screenshots - #+CAPTION: The main conversion interface - [[./screenshots/main-interface-dimension-converter.png]] - #+CAPTION: A secondary, more complicated conversion option - [[./screenshots/main-interface-expression-converter.png]] +#+CAPTION: The main conversion interface +[[./screenshots/main-interface-dimension-converter.png]] +#+CAPTION: A secondary, more complicated conversion option +[[./screenshots/main-interface-expression-converter.png]] +** How to Use 7Units +7Units uses Gradle as its build system. + +- To build 7Units: ~./gradlew build~. + This creates a test report at ~build/reports/tests/test/index.html~ and a Jacoco code coverage report at ~build/reports/jacoco/test/html/index.html~. +- To run 7Units: ~./gradlew run~. +- To generate Javadoc: ~./gradlew javadoc~. + The Javadoc will be at ~build/docs/javadoc/index.html~. +- To create a JAR: ~./gradlew jar~. + The JAR will be at ~build/libs/sevenUnits.jar~. + +Instructions on using the program itself can be found at ~docs/manual.pdf~. |