diff --git a/README.md b/README.md index 9569fb3..4f742c3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,67 @@ -# ckconv -Commandline unit converter for Bethesda games. +
This is a commandline utility that converts between common length measurement units & Bethesda's arbitrary Unit
+ +## 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;