aspect-ratio-cli 0.1.2

A simple Rust library to calculate aspect ratio
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# Aspect Ratio

## Table of Contents

- [Aspect Ratio](#aspect-ratio)
  - [Table of Contents](#table-of-contents)
  - [About](#about)
  - [Getting Started](#getting-started)
    - [Prerequisites](#prerequisites)
    - [Building](#building)
    - [Installing](#installing)
    - [Uninstalling](#uninstalling)
  - [Usage](#usage)
  - [Examples](#examples)
  - [License](#license)

![Crates.io Version](https://img.shields.io/crates/v/aspect-ratio-cli?style=for-the-badge)
![Crates.io Total Downloads](https://img.shields.io/crates/d/aspect-ratio-cli?style=for-the-badge)
![Crates.io Size (version)](https://img.shields.io/crates/size/aspect-ratio-cli/0.1.1?style=for-the-badge)

## About

**Aspect Ratio** is a simple CLI tool written in Rust for quickly reducing width and height values to their simplest aspect ratio form. It supports multiple input formats and is designed for fast, efficient use in the terminal.

## Getting Started

Follow these instructions to build and use the project on your local machine.

### Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) (version 1.82.0 or later)
- Cargo (comes with Rust)

### Building

Clone the repository and build the project:

```sh
git clone https://github.com/anhkhoakz/some-rust-scripts/
cd aspect-ratio
cargo build --release
```

### Installing

To install the binary system-wide (requires sudo):

```sh
sudo make install
```

You can also install it from crates.io:

```sh
cargo install aspect-ratio-cli
```

### Uninstalling

To remove the installed binary:

```sh
make uninstall
```

Or, if installed via Cargo:

```sh
cargo uninstall aspect-ratio-cli
```

## Usage

You can run the tool with:

```sh
./target/release/aspect-ratio-cli <width> <height>
./target/release/aspect-ratio-cli <width>x<height>
./target/release/aspect-ratio-cli <width>:<height>
```

Or, if installed system-wide or via Cargo, you can run it directly:

```sh
aspect-ratio-cli <width> <height>
aspect-ratio-cli <width>x<height>
aspect-ratio-cli <width>:<height>
```

## Examples

```sh
$ aspect-ratio-cli 1920 1080
16:9

$ aspect-ratio-cli 1280x720
16:9

$ aspect-ratio-cli 1024:768
4:3
```

If you provide invalid input, the tool will print an error and usage instructions.

## License

This project is licensed under the GNU General Public License version 2. See the [LICENSE](LICENSE) file for details.