moins 0.5.0

A Keep It Simple Stupid pager crate
Documentation 
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

# Moins [![Latest Version]][crates.io] [![Build Status]][travis]

[Build Status]: https://travis-ci.org/oknozor/moins.svg?branch=master
[travis]: https://travis-ci.org/oknozor/musicbrainz_rs
[Latest Version]: https://img.shields.io/crates/v/moins.svg
[crates.io]: https://www.crates.io/crates/moins


🥖 *"moins"* is french for *"less"* 🥖 ! .

## What is moins ?

Moins is a Keep It Simple Stupid less like pager that you can use as a crate.

It aims to be used in other cli app project, you probably don't want to use it as a replacement for less, cause it does less than less.

## How to

Add moins to your `Cargo.toml` dependencies.

```toml
[dependencies]
moins = "0.1.0"
```

Moins expose a single `run` function and a `PagerOption` struct to define your pager behavior.

Here is the simplest pager you can run :

```rust
extern crate moins;

use moins::Moins;

fn main() {
    let mut content = String::from("👋 🌎!");
    Moins::run(&mut content, None);
}
```

If you want to add some colors to the pager you can add pagers options :

```rust
let mut content = "A noir, E blanc, I rouge, U vert, O bleu, voyelles,
Je dirai quelque jour vos naissances latentes.
A, noir corset velu des mouches éclatantes
Qui bombillent autour des puanteurs cruelles"
.to_owned();

let mut colors = HashMap::new();
colors.insert("A", Color::Black);
colors.insert("E", Color::White);
colors.insert("I", Color::Red);
colors.insert("U", Color::Green);
colors.insert("O", Color::Blue);

let options = PagerOptions {
    colors,
    search: false,
    line_number: false,
};

Moins::run(&mut content, Some(options));
```

you can run the examples with the command `cargo run --example my_example`

## Search

WIP

## Line number

WIP

## Key binding

| Key | Action |
|:--  | :---   |
| `Arrow up` | scroll up |
| `k` | scroll up |
| `Arrow down` | scroll down |
| `j` | scroll down |
| `q` | quit |

## Contributing

Contribution are welcome, don't hesitate to submit a PR or fill an issue but keep in mind that moins is a stupid pager. We don't want syntax hilighting, or any fancy feature. If you are looking for something like that [bat](https://github.com/sharkdp/bat) is probably what you need.