Update docs

bem-archive · Jan 31, 2015 · 79d550d · 79d550d
1 parent 8a334cf
commit 79d550d
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -24,19 +24,21 @@ Run:
 $ yo bem-stub
 ```
 
-To create the config file fitting for your project, the generator will ask several questions. Note that some of them depend on the previous ones, for example:
-
-* If you have chosen library [bem-components](https://bem.info/libs/bem-components/), `generator-bem-stub` will choose [Autoprefixer](https://github.com/postcss/autoprefixer) and CSS preprocessor [Stylus](https://github.com/LearnBoost/stylus) as default.
+### Options
 
-* You can choose template engine [BH](https://bem.info/technology/bh/) only if you have chosen assembler [ENB](https://github.com/enb-make/enb).
+* **skip-install** - skip the installation of dependencies and libraries after generation of the project.
 
-* If you have not chosen technology [BEMJSON](https://bem.info/technology/bemjson/current/bemjson/), bundles will be assembled from **BEMDECL**.
+```bash
+$ yo bem-stub --skip-install
+```
 
-* You can build HTML only if you have chosen technology [BEMJSON](https://bem.info/technology/bemjson/current/bemjson/) and template engine [BEMHTML](https://bem.info/technology/bemhtml/current/intro/) or [BH](https://bem.info/technology/bh/).
+* **tab-size** - tab size of the generated code in spaces. Specify `0` to generate tabs instead of spaces (Default: `4`).
 
-* You will be able to choose which separate files to minimize only if you have chosen assembler [ENB](https://github.com/enb-make/enb) ([bem-tools](https://bem.info/tools/bem/bem-tools/) does not support configuration of minimization, all possible files are minimized by [borschik](https://bem.info/tools/optimizers/borschik/)).
+```bash
+$ yo bem-stub --tab-size=4
+```
 
-### What does generator-bem-stub support?
+## What does generator-bem-stub support?
 
 * Assemblers:
  * [bem-tools](https://bem.info/tools/bem/bem-tools/)
@@ -64,17 +66,19 @@ To create the config file fitting for your project, the generator will ask sever
 * Building of HTML
 * Minimization of separate files (only in [ENB](https://github.com/enb-make/enb))
 
-### Installation of dependencies
+To create the config file fitting for your project, the generator will ask several questions. Note that some of them depend on the previous ones, for example:
 
-`generator-bem-stub` will install all dependencies and libraries after generation of the project.
+* If you have chosen library [bem-components](https://bem.info/libs/bem-components/), `generator-bem-stub` will choose [Autoprefixer](https://github.com/postcss/autoprefixer) and CSS preprocessor [Stylus](https://github.com/LearnBoost/stylus) as default.
 
-If you do not want to install dependencies and libraries, use the option `--skip-install`:
+* You can choose template engine [BH](https://bem.info/technology/bh/) only if you have chosen assembler [ENB](https://github.com/enb-make/enb).
 
-```bash
-$ yo bem-stub --skip-install
-```
+* If you have not chosen technology [BEMJSON](https://bem.info/technology/bemjson/current/bemjson/), bundles will be assembled from **BEMDECL**.
+
+* You can build HTML only if you have chosen technology [BEMJSON](https://bem.info/technology/bemjson/current/bemjson/) and template engine [BEMHTML](https://bem.info/technology/bemhtml/current/intro/) or [BH](https://bem.info/technology/bh/).
+
+* You will be able to choose which separate files to minimize only if you have chosen assembler [ENB](https://github.com/enb-make/enb) ([bem-tools](https://bem.info/tools/bem/bem-tools/) does not support configuration of minimization, all possible files are minimized by [borschik](https://bem.info/tools/optimizers/borschik/)).
 
-### Versions
+## Versions
 
 You can check in the file [app/config/versions.js](https://github.com/bem/generator-bem-stub/blob/master/app/config/versions.js) which versions of the dependencies and libraries `generator-bem-stub` uses.
 
diff --git a/README.ru.md b/README.ru.md
@@ -24,21 +24,17 @@ $ npm install -g generator-bem-stub
 $ yo bem-stub
 ```
 
-Чтобы создать оптимальный для вашего проекта конфигурационный файл, генератор задаст несколько вопросов, от которых будет зависеть последующая конфигурация сборки.
-
-Важно знать, что многие вопросы в `generator-bem-stub` зависят друг от друга, например:
-
-* Если вы выбрали библиотеку [bem-components](https://ru.bem.info/libs/bem-components/), `generator-bem-stub` выберет [Автопрефиксер](https://github.com/postcss/autoprefixer) и CSS-препроцессор [Stylus](https://github.com/LearnBoost/stylus) по умолчанию.
-
-* Возможность использования [BH](https://ru.bem.info/technology/bh/)-шаблонизатора появляется только при выборе сборщика [ENB](https://github.com/enb-make/enb).
+### Опции
 
-* Бандлы будут собираться из **BEMDECL**, если вы не выбрали технологию [BEMJSON](https://ru.bem.info/technology/bemjson/current/bemjson/).
+* **skip-install** - не устанавливать зависимости и бибилиотеки, после генерации проекта.
 
-* Вы можете собирать HTML, только если выбрали технологию [BEMJSON](https://ru.bem.info/technology/bemjson/current/bemjson/) и шаблонизатор [BEMHTML](https://ru.bem.info/technology/bemhtml/current/intro/) или [BH](https://ru.bem.info/technology/bh/).
+* **tab-size** - размер символов табуляции в сгенерированном коде. Укажите `0`, чтобы генерировались символы табуляции вместо пробелов. (По умолчанию: `4`).
 
-* У вас будет возможность выбрать, какие конкретно файлы минимизировать, только если вы выбрали сборщик [ENB](https://github.com/enb-make/enb). ([bem-tools](https://ru.bem.info/tools/bem/bem-tools/) не предоставляет возможность конфигурировать минимизацию файлов, все возможные файлы минимизируются с помощью [borschik](https://ru.bem.info/tools/optimizers/borschik/)).
+```bash
+$ yo bem-stub --tab-size=4
+```
 
-### Что поддерживает generator-bem-stub?
+## Что поддерживает generator-bem-stub?
 
 * Сборщики:
  * [bem-tools](https://ru.bem.info/tools/bem/bem-tools/)
@@ -66,16 +62,20 @@ $ yo bem-stub
 * Сборка HTML
 * Минимизиция отдельных файлов (доступна только в [ENB](https://github.com/enb-make/enb))
 
-### Установка зависимостей
+Чтобы создать оптимальный для вашего проекта конфигурационный файл, генератор задаст несколько вопросов, от которых будет зависеть последующая конфигурация сборки.
 
-`generator-bem-stub` установит все зависимости и библиотеки после генерации проекта.
+Важно знать, что многие вопросы в `generator-bem-stub` зависят друг от друга, например:
 
-Чтобы не устанавливать зависимости и библиотеки, используйте опцию `--skip-install`:
+* Если вы выбрали библиотеку [bem-components](https://ru.bem.info/libs/bem-components/), `generator-bem-stub` выберет [Автопрефиксер](https://github.com/postcss/autoprefixer) и CSS-препроцессор [Stylus](https://github.com/LearnBoost/stylus) по умолчанию.
 
-```bash
-$ yo bem-stub --skip-install
-```
+* Возможность использования [BH](https://ru.bem.info/technology/bh/)-шаблонизатора появляется только при выборе сборщика [ENB](https://github.com/enb-make/enb).
+
+* Бандлы будут собираться из **BEMDECL**, если вы не выбрали технологию [BEMJSON](https://ru.bem.info/technology/bemjson/current/bemjson/).
+
+* Вы можете собирать HTML, только если выбрали технологию [BEMJSON](https://ru.bem.info/technology/bemjson/current/bemjson/) и шаблонизатор [BEMHTML](https://ru.bem.info/technology/bemhtml/current/intro/) или [BH](https://ru.bem.info/technology/bh/).
+
+* У вас будет возможность выбрать, какие конкретно файлы минимизировать, только если вы выбрали сборщик [ENB](https://github.com/enb-make/enb). ([bem-tools](https://ru.bem.info/tools/bem/bem-tools/) не предоставляет возможность конфигурировать минимизацию файлов, все возможные файлы минимизируются с помощью [borschik](https://ru.bem.info/tools/optimizers/borschik/)).
 
-### Версии
+## Версии
 
 В файле [app/config/versions.js](https://github.com/bem/generator-bem-stub/blob/master/app/config/versions.js) указано, какие версии зависимостей и библиотек использует `generator-bem-stub`.