Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/radj307/ckconv
Browse files Browse the repository at this point in the history
  • Loading branch information
radj307 committed Aug 20, 2022
2 parents 673acbd + 09bca94 commit 204466a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/GenerateRelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
runs-on: ${{matrix.os}}
strategy:
matrix:
os: [ ubuntu-latest, windows-2022, macos-latest ]
os: [ ubuntu-latest, windows-latest, macos-latest ]
fail-fast: true

steps:
Expand Down
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,19 @@
<br />
<a href="https://github.com/radj307/Gamebryo-Engine-Unit-Converter/tags"><p align="center"><img alt="GitHub tag (latest by date)" src="https://img.shields.io/github/v/tag/radj307/ckconv?color=ffffff&label=Current%20Version&logo=github&style=for-the-badge"></a>&nbsp&nbsp<a href="https://github.com/radj307/ckconv/releases"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/radj307/ckconv/total?color=ffffff&logo=github&style=for-the-badge"></p></a>



<p align="center">This is a commandline utility that converts between common length measurement units & Bethesda's arbitrary <a href="https://www.creationkit.com/index.php?title=Unit"><i>Unit</i></a></p>

## Features
- Context-Sensitive Notation
- Can be overridden:
- Force standard notation with `--standard` or `--fixed`.
- Force scientific notation with `--scientific` or `--sci`.
- Supports these measurement units:
- Metric
- Includes all metric prefixes from `pico-` to `tera-`
- Imperial
- Includes all Imperial length units listed on [wikipedia](https://en.wikipedia.org/wiki/Imperial_units#Length).
- Gamebryo / CreationKit Units
- Includes all metric prefixes from `pico-` to `tera-` because who doesn't want to use kilounits
- Cross-Platform:
- Windows
- Linux
- macOS
-


If you're new to using CLI programs, see the [beginners guide](https://github.com/radj307/Gamebryo-Engine-Unit-Converter/wiki#detailed-usage-guide-for-less-experienced-terminal-users).
If you're new to using CLI programs, see the [beginners guide](https://github.com/radj307/ckconv/wiki#detailed-usage-guide-for-less-experienced-terminal-users).

## Installation
No formal installation is required, simply place the executable somewhere and call it from your preferred shell.
Expand All @@ -34,11 +24,12 @@ If you're new to using CLI programs, see the [beginners guide](https://github.co
The program is small enough to embed within another executable, for an example see [this synthesis patcher](https://github.com/radj307/Metric-Units-Patcher).

### Adding to your PATH variable

#### Linux
Place the executable in `/usr/local/bin` to add to your path, or add `export PATH='$PATH;<PATH_TO_DIRECTORY>'` to the end of `~/.bashrc`

#### Windows
[See Here](https://stackoverflow.com/a/9546345/8705305)
[See this stackoverflow answer](https://stackoverflow.com/a/9546345/8705305)

#### macOS
I genuinely have no idea as I have never owned or used a mac, but I assume it's similar to Linux.
Expand All @@ -62,6 +53,8 @@ If you're new to using CLI programs, see the [beginners guide](https://github.co
![](https://i.imgur.com/djxJO0t.png)
![](https://i.imgur.com/WvhAz51.png)

Converting 5 picometers to units in standard notation, and response-only mode:
Converting 5 picometers to units, printed in standard notation:
![](https://i.imgur.com/HoykBM7.png)
![](https://i.imgur.com/fLj1yvU.png)
![](https://i.imgur.com/fLj1yvU.png)

With [v6.0.0](https://github.com/radj307/ckconv/releases/6.0.0) comes less-strict syntax support. That means you can use expressions like `260m u` or `260 m u` instead of the more strict `<UNIT> <VALUE> <OUTPUT_UNIT>` syntax required by previous versions.

0 comments on commit 204466a

Please sign in to comment.