Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.87 KB

README.md

File metadata and controls

59 lines (38 loc) · 1.87 KB
Raw
      ▪  ▄▄ 
▪     ██ ██▌
 ▄█▀▄ ▐█·▐█·
▐█▌.▐▌▐█▌.▀ 
 ▀█▄▀▪▀▀▀ ▀  - trivia on the command line

Documentation is my...

define_ah

use oi --help for full usage information

dependencies:

on all platforms the only thing you need installed is cargo.

  • Windows: https://win.rustup.rs/
  • Linux/macOS: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh (or use your distro's package manager)

this is only required for building the binary, if you have no more use for cargo you can remove it afterwards

build instructions:

clone repo

cd into repo root

Linux

an install script has been provided, just run ./install.sh

macOS

run cargo build --release

then sudo cp ./target/release/oi /usr/local/bin

a zsh completion script is located at the following path ./etc/completions/_oi but I currently have no idea where to put it (sorry!)

Windows

run cargo build --release

then make a new folder in a location of your choosing

copy .\target\release\oi.exe [letter]:\path\to\your\folder

following this guide you can add your new folder to you environment PATH

a PowerShell completion script is located at the following path .\etc\completions\_oi.ps1 but I currently have no idea where to put it (sorry!)

I'll be providing pre compiled binaries for Linux, Windows & macOS in the releases section soon

TODO:

  • shell completion scripts
  • add a proper release with binaries
  • license?
  • improve docs
  • user customisable colours (using an environment variable)
  • general code improvements (and probable bug fixes)