[go: up one dir, main page]

lipsum 0.3.0

Lipsum is a lorem ipsum text generation library. Use this if you need some filler text for your application. The text is generated using a simple Markov chain, which you can also instantiate to generate your own pieces of pseudo-random text.
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
92
93
94
95
96

# Lorem Ipsum

[![](https://img.shields.io/crates/v/lipsum.svg)][crates-io]
[![](https://docs.rs/lipsum/badge.svg)][api-docs]
[![](https://travis-ci.org/mgeisler/lipsum.svg)][travis-ci]
[![](https://ci.appveyor.com/api/projects/status/ku3xlumht6r68f0l?svg=true)][appveyor]

This is small Rust library for generating traditional
mangled-Latin [lorem ipsum filler text][lorem ipsum] for your
application.


## Usage

Add this to your `Cargo.toml`:
```toml
[dependencies]
lipsum = "0.3"
```

and this to your crate root:
```rust
extern crate lipsum;
```


## Documentation

Please see the **[API documentation][api-docs]**.


## Getting Started

Use the `lipsum` function to generate lorem ipsum text:
```rust
extern crate lipsum;

use lipsum::lipsum;

fn main() {
    // Print 25 random words of lorem ipsum text.
    println!("{}", lipsum(25));
}
```

The text will start with "Lorem ipsum dolor sit amet, …" and will
become random after 18 words. The text is generated using a Markov
chain which is trained on the full text of Cicero's work *De finibus
bonorum et malorum* ("On the ends of good and evil"). The classic
lorem ipsum text is derived from part of that book.


## Release History

### Version 0.3.0 — July 28th, 2017

Performance is improved by about 50% when generating text, but
training the Markov chain now takes about twice as long as before.

The `MarkovChain` struct has many new methods:

* `new_with_rng` makes it possible to specify the random number
  generator used by the Markov chain. Use this to get deterministic
  and thus reproducible output for tests. `MarkovChain` now owns the
  RNG it uses and as a consequence, it has an extra type parameter.
  This is a breaking change if you used struct directly in your code.

* `iter` and `into_from` return iterators over words in the Markov
  chain. The `generate` and `generate_from` methods are now
  straight-forward convenience wrappers for the iterators.

* `len` tells you the number of stats in the Markov chain and
  `is_empty` tells you if the Markov chain is empty, meaning that it
  hasn't been trained on anything yet.

### Version 0.2.0 — July 10th, 2017

Rust version 1.6.0 is now supported. This is checked with TravisCI.

### Version 0.1.0 — July 2nd, 2017

First public release.


## License

Lipsum can be distributed according to the [MIT license][mit].
Contributions will be accepted under the same license.


[crates-io]: https://crates.io/crates/lipsum
[api-docs]: https://docs.rs/lipsum/
[lorem ipsum]: https://en.wikipedia.org/wiki/Lorem_ipsum
[travis-ci]: https://travis-ci.org/mgeisler/lipsum
[appveyor]: https://ci.appveyor.com/project/mgeisler/lipsum
[mit]: LICENSE