graphics/viu
graphics/viu
1
0
Fork 0
mirror of https://github.com/atanunq/viu synced 2024-10-18 13:02:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removed WASI Readme

Browse source
This commit is contained in:
Syrus 2019-05-28 15:21:09 -07:00
parent 178b6f0512
commit 0360c0c47a
3 changed files with 12 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored
View file

@ -2,6 +2,10 @@
# will have compiled files and executables
/target/
# Generated by WAPM
/wapm_packages/
wapm.lock
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
#Cargo.lock

8
README.md
View file

@ -12,6 +12,14 @@ Features (see [Usage](#usage)):
### Installation
#### From wapm
Viu can be installed in Linux, macOS and Windows using [wapm](https://wapm.io/):
```bash
wapm install -g viu
```
#### From source
Installation from source requires a local [Rust environment](https://www.rust-lang.org/tools/install).

85
WASI-README.md
View file

@ -1,85 +0,0 @@
# viu
A small command-line application to view images from the terminal written in Rust.
It uses lower half blocks (▄ or \u2584) to fit 2 pixels into a single cell by adjusting foreground and background colours accordingly.
Features (see [Usage](#usage)):
- Animated GIF support
- Accept media through stdin
- Custom dimensions
### Installation
```bash
wapm install -g viu
```
### Usage
![Demo](https://github.com/wapm-packages/viu/blob/master/img/wapm-demo.gif?raw=true)
Ctrl-C was pressed to stop the GIFs.
Examples:
- `viu --dir=. img/giphy.gif`
- `viu --dir=. img/*`
The shell will expand the wildcard above and *viu* will display all the images in the folder one after the other. For a more informative output when dealing with folders the flag **-n** could be used.
When `viu` receives only one file and it is GIF, it will be displayed over and over until Ctrl-C is pressed. However, when couple of files are up for display (second example) the GIF will be displayed only once.
##### Aspect Ratio
If no flags are supplied to *viu* it will try to get the size of the terminal where it was invoked. If it succeeds it will fit the image and preserve the aspect ratio. The aspect ratio will be changed only if both options **-w** and **-h** are used together.
##### Command line options
```
USAGE:
viu [FLAGS] [OPTIONS] <FILE>...
FLAGS:
-m, --mirror Display a mirror of the original image
-t, --transparent Display transparent pixels in the color of the terminal
-n, --name Output the name of the file before displaying
-v, --verbose Output what is going on
OPTIONS:
-h, --height <height> Resize the image to a provided height
-w, --width <width> Resize the image to a provided width
ARGS:
<FILE>... The image to be displayed
```
## Building from Source
First, you will need the WASI target installed in your Rust system:
```shell
rustup target add wasm32-wasi --toolchain nightly
```
Once WASI is available, you can build the WebAssembly binary by yourself with:
```shell
cargo +nightly build --release --target wasm32-wasi
```
This will create a new file located at `target/wasm32-wasi/release/viu.wasm`.
When the wasm file is created you can upload it to wapm or execute it with wasmer:
```shell
wapm publish
# OR
wasmer run target/wasm32-wasi/release/viu.wasm --dir=. -- img/giphy.gif
```
You can also build a native executable with
```shell
cargo build
```