From f9f462cd2feb811891fe4e4919534cbdb6dcba2c Mon Sep 17 00:00:00 2001
From: nsfisis <nsfisis@gmail.com>
Date: Tue, 8 Dec 2020 02:53:10 +0900
Subject: first commit

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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)
-- 
cgit v1.2.3-70-g09d2