diff options
| author | nsfisis <nsfisis@gmail.com> | 2020-12-08 02:53:10 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2020-12-08 02:55:44 +0900 |
| commit | f9f462cd2feb811891fe4e4919534cbdb6dcba2c (patch) | |
| tree | ecb670b0242daa7e7e1df77c146f3881c3e075e8 /README.md | |
| download | rand-word-gen-f9f462cd2feb811891fe4e4919534cbdb6dcba2c.tar.gz rand-word-gen-f9f462cd2feb811891fe4e4919534cbdb6dcba2c.tar.zst rand-word-gen-f9f462cd2feb811891fe4e4919534cbdb6dcba2c.zip | |
first commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1cbb290 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Random word generator + +Generates random pseudo-English words. It is mainly for naming your hobby projects in a moment. + +It internally uses "Markov chain" to generate words. The chain model is built in a compiling phase of the tool, referring to `words` file (`/usr/share/dict/words`). + +## Usage + +``` +$ rand-word-gen +eendo +ddips +uphr +blinta +unto +ont +vedaro +dera +ekarrb +goice +sfodo +ainis +rier +fatem +myimd +grasic +honge +ustoge +ear +nal + +# Sets a number of generated words. +$ rand-word-gen -n 5 +piva +ors +glo +mapt +blclyp +``` + +See `rand-word-gen --help` for details. + +## Build + +``` +$ cargo build --release +``` + +## TODO + +* Pass a custom words file at runtime. +* Specify length of generated words. + +## License + +MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |