summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..148087b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+utaten2tex: convert lyrics from `utaten.com` to LaTeX
+
+Usage: <main.py> [path_to_html_file]
+
+If HTML file is not specified, the program will read HTML text from STDIN.
+
+Example:
+
+```shell
+curl https://utaten.com/lyric/sa16080309/ | python3 main.py
+```
+
+Make sure you have `beautifulsoup` and `html5lib` installed. \ No newline at end of file