update readme.md

1 files changed, 23 insertions, 9 deletions

diff --git a/README.md b/README.md
index 8f3a7bc..002f480 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,17 @@
-# triumfalno #
+# triumfalno
 
-Расшифровка АРГ про Ростов и ВОЕННОЕ ВМЕШАТЕЛЬСТВО ЭРДОГАН ТРИУМФАЛЬНО.
+Расшифровка АРГ(?) про Ростов и ВОЕННОЕ ВМЕШАТЕЛЬСТВО ЭРДОГАН ТРИУМФАЛЬНО.
 
-## Расшифованные данные ##
+## Расшифованные данные
 
 Все карты и тексты - на странице [data.md](./data.md).
 
-## Как пользоваться скриптом ##
+## Как пользоваться скриптом
 ```
 ./main.py --help
 ```
 
-Опция `--decode` расшифровывает и выводит все строчки из `data.json`.
+Опция `--decode` расшифровывает и выводит все строчки из `data.json`, которые принадлежат указанному `--type`.
 
 Через `--decode-string "ВОЕННОЕ ВМЕШАТЕЛЬСТВО ТРИУМФАЛЬНО"` можно расшифровывать произвольные строки.
 
@@ -19,10 +19,24 @@
 
 Опция `--with-junk` пропускает удаление мусорных слов (бывает полезно, чтобы посмотреть как будет без удаления, на случай если удаляется что-то лишнее).
 
-Через `--type` можно задать тип шифровок (`1` или `2`). 1 это обычные, составленные из слов, 2 появился позднее, он составлен из предложений.
+Через `--type` можно задать тип шифровок (`1` или `2`). 1 это обычные, составленные из слов, 2 появился позднее, он составлен из предложений. Значение по умолчанию - `1`.
 
-## Другое ##
+## Пример
 
-В файле `data.json` лежат тексты и метаинформация, собранные с архивов двача и фейсбука. Из этого файла генерируется страничка `data.md`.
+Например, если ты нашел такой текст: 
 
-Работает на Python 3, рекомендуется установить модуль `termcolor` чтобы вывод был цветным.
+> Фехтовальные Навыки Отмечено! ТРИУМФАЛЬНО! Отмечено! РОБОТИЧЕСКИ Отмечено! Беркут Отмечено! ТРИУМФАЛЬНО! 80% ТРИУМФАЛЬНО! Отмечено! Чечевичная похлебка ЗАКОННО! Номер Индексирован Безукоризненно Отмечено! Сухогруз Откладывается Линейно ТРИУМФАЛЬНО! Ь - Его Величество
+
+и хочешь его расшифровать, то делаешь либо `./main.py --decode-string "...этот текст в кавычках..."` (но у меня шелл ругается из-за того, что в строке присутствуют восклицательные знаки, поэтому есть следующий вариант с файлом), либо записываешь его в файл, скажем `/tmp/text.txt`, и делаешь `./main.py --decode-file /tmp/text.txt`.
+
+## Другое
+
+В файле `data.json` лежат тексты и метаинформация, собранные с архивов двача и со страниц соцсетей. Из этого файла генерируется страничка `data.md`.
+
+Скрипт `search_2ch_archive.py` ищет треды в [архиве /b/](https://2ch.hk/b/arch/) по известным ключевым словам.
+
+Скрипт `analyze_new.py` - черновик частотного анализа положения букв для расшифровки шифртекстов 3-го типа, тексты которых лежат в папке `new` (см. [data.md](./data.md) о типах).
+
+## Требования
+
+Работает на Python 3. Рекомендуется установить модуль `termcolor` чтобы вывод был цветным. Для `search_2ch_archive.py` нужен модуль `requests`. Для корректной работы `gen_md.py` нужен установленный `imagemagick` в системе (используется утилита `convert` для создания превьюшек). Предполагается использование на unix-like системах.