-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/radj307/ckconv
- Loading branch information
Showing
1 changed file
with
67 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,67 @@ | ||
| # ckconv | ||
| Commandline unit converter for Bethesda games. | ||
| <h1 align="center">Bethesda Engine Unit Converter</h1> | ||
| <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>  <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). | ||
|
|
||
| ## Installation | ||
| No formal installation is required, simply place the executable somewhere and call it from your preferred shell. | ||
|
|
||
| If you want to be able to use the program no matter your shell's current working directory, you'll need to place the executable in a location found in your `PATH` environment variable. | ||
|
|
||
| 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) | ||
|
|
||
| #### macOS | ||
| I genuinely have no idea as I have never owned or used a mac, but I assume it's similar to Linux. | ||
|
|
||
| ## Usage | ||
| Use `ckconv -h` or `ckconv --help` to see a usage guide, and documentation on all of the available options. | ||
|
|
||
| Use `ckconv --units` to see a list of all recognized units. | ||
| When specifying units, you can use the values in the `Symbol` or `Name` columns. | ||
|
|
||
| ### Examples | ||
| Simple conversions, and pipe operators: | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| Multiple conversions at once: | ||
|  | ||
|  | ||
|  | ||
|
|
||
| Converting 5 picometers to units in standard notation, and response-only mode: | ||
|  | ||
|  |