Added README

Signed-off-by: Louis Vallat <louis@louis-vallat.xyz>
2022-02-02 10:50:59 +01:00 · 2022-02-02 10:50:59 +01:00 · 36138f3822
commit 36138f3822
parent e7b56fa634
1 changed files with 19 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,19 @@
+# Mettallibruh
+
+> Generates new and original lyrics from a set of existing lyrics.
+
+## Format
+
+The input file should be formatted such as:
+
+- one line <=> one sentence
+- sentences should end with dots, always
+
+## How to use
+
+```bash
+cargo run --release -- ./input
+```
+
+> This was made as a quick implementation for an idea.
+