From d7353eda575d506374761e23a5c4e4667418da0f Mon Sep 17 00:00:00 2001
From: rusinthread <rusinthread@cock.li>
Date: Fri, 23 Dec 2016 02:09:28 +0300
Subject: add readme

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

(limited to 'README.md')

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` чтобы вывод был цветным.
-- 
cgit v1.2.3