Skip to content

Commit

Permalink
Revert "update readme"
Browse files Browse the repository at this point in the history
This reverts commit c7953d3.
  • Loading branch information
explosion-mental committed Mar 9, 2023
1 parent c7953d3 commit 4639602
Showing 1 changed file with 37 additions and 27 deletions.
64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,56 @@
```
▪ ▄▄
▪ ▄▄
▪ ██ ██▌
▄█▀▄ ▐█·▐█·
▐█▌.▐▌▐█▌.▀
▐█▌.▐▌▐█▌.▀
▀█▄▀▪▀▀▀ ▀ - trivia on the command line
```
**Documentation is my...**
#### Documentation is my...

![achilles heel](https://user-images.githubusercontent.com/53883649/146692265-ec042204-7cbd-4918-89fa-10d47d1bf621.jpg)
![define_ah](https://user-images.githubusercontent.com/53883649/146692265-ec042204-7cbd-4918-89fa-10d47d1bf621.jpg)

use `oi --help` for full usage information
use ```oi --help``` for full usage information

## Dependencies
[cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
## 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:
First `git clone https://github.com/explosion-mental/oi` and then `cd oi`. Then
follow the instructions for your platform.

### Linux
an install script has been provided, just run `./install.sh`
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```

### macOS
1. `cargo build --release`
2. `sudo cp ./target/release/oi /usr/local/bin`
3. (optional) a zsh completion script is located at the following path
`./etc/completions/_oi` but I currently have no idea where to put it (sorry!)
following [this](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53) guide you can add your new folder to you environment PATH

### Windows
1. `cargo build --release`
2. make a new folder in a location of your choosing
3. `copy .\target\release\oi.exe [letter]:\path\to\your\folder`
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!)

following
[this](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53)
guide you can add your new folder to you environment `PATH`
##### I'll be providing pre compiled binaries for Linux, Windows & macOS in the releases section soon

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!)
### TODO:

## TODO
- [x] shell completion scripts
- [ ] add a proper release with binaries
- [ ] license?
Expand Down

0 comments on commit 4639602

Please sign in to comment.