summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrusinthread <rusinthread@cock.li>2016-12-23 02:09:28 +0300
committerrusinthread <rusinthread@cock.li>2016-12-23 02:09:28 +0300
commitd7353eda575d506374761e23a5c4e4667418da0f (patch)
tree6482317cbf20aba4011bfb74f8e3e479d450a8dc
parent1cca842cdd1a2646ad84b82adf0e8ce5fee51871 (diff)
add readme
-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..75fd1ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# triumfalno #
+
+Специально для Русин-треда.
+
+### Как пользоваться ###
+```
+./main.py decode --remove-junk
+```
+Опция `--remove-junk` удаляет мусорные слова из текстов перед обработкой.
+
+В файле `data.json` лежат тексты и метаинформация, собранные с архивов двача и фейсбука. Кроме `pic` там ничего полезного нет. В папке `img` лежат связанные с текстами изображения.
+
+Работает на `Python 3`, рекомендуется установить модуль `termcolor` чтобы вывод был цветным.