ropipe/README.md

64 lines
1.2 KiB
Markdown

# Ropipe
![GitHub](https://img.shields.io/github/license/MatMasIt/ropipe)
> Convert roman numbers to integers and vice-versa in pipes
## What is ropipe?
Ropipe converts decimal integers to roman numbers and vice versa, reading from stdin and printing to stdout, it is meant to primarily be used in pipes.
Default is integer to roman.
## Options
* -r : Roman to integer. Integer to roman is the default.
## Installation
1. Clone this repository
2. `cd` into it
3. run
```sh
sudo make install
```
or
```sh
doas make install
```
(The program is compiled at this time, you may check the script and the program out beforehand)
## Examples
Once installed, you can find sample files in the project dir.
---
Example 1:
```sh
ropipe < arabic.txt
```
Result:
```
I
X
CXXIII
CCCXXI
```
---
Example 2:
```sh
ropipe -r < roman.txt
```
Result:
```
4
5
7
1200
```
## Manpage
A manpage is installed alongside the program, try running `man ropipe`
## Updates
There is no automatic update system as of yet, you are advised to regularly visit https://github.com/MatMasIt/ropipe, download and re-run the installer in order to get updates
## Make commands
* `make`: compile ropipe
* `make install`: install ropipe
* `make uninstall`: uninstall ropipe