Skip to content
This repository has been archived by the owner on Jan 13, 2018. It is now read-only.

Commit

Permalink
Update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tadatuta committed Jul 17, 2015
1 parent 5fe276a commit 13b7bef
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 68 deletions.
6 changes: 6 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
bem-tools changelog
===================

0.10.0 (stable)
- ENB is used as a fallback for `bem make` and `bem server`
- Support for native `bem make` config is deprecated and will be removed in next version
- Updated npm dependencies
- Run tests on node.js 0.12 and io.js

0.9.0 (stable)
--------------
- Use clean-css instead of CSSO
Expand Down
14 changes: 14 additions & 0 deletions ChangeLog.ru.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
История изменений
=================

0.10.0 (стабильная)
- ENB используется как fallback для `bem make` и `bem server`
- Поддержка «родного» конфига `bem make` объявлена устаревшей и будет удалена в следующей версии
- Обновлены npm-зависимости
- Включены тесты в node.js 0.12 и io.js

0.9.0 (стабильная)
--------------
- Перешли на `clean-css` вместо `CSSO`.
— Обновили `borschik` до `~1.2.0`.
- Технологии `less` и `stylus` теперь собирают предварительные файлы.
- Добавлены шаблоны для `bem create`.
- Не запускаем тесты на `node.js 0.8`.

0.8.0 (стабильная)
--------------
- Обновили версию borschik до [1.0.1](https://github.com/bem/borschik/blob/master/CHANGELOG.ru.md#101).
Expand Down
43 changes: 10 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,9 @@
Toolkit to work with files based on [BEM methodology](http://bem.github.com/bem-method/pages/beginning/beginning.en.html).

## Installation
You need [NodeJS 0.6+](http://nodejs.org/) or later and [npm 1.x](http://npmjs.org/).
After this it suffices `npm -g install bem`.
You need [NodeJS 0.10+](http://nodejs.org/) or later and [npm 2.x+](http://npmjs.org/).

* Install [nodejs](http://nodejs.org)

https://github.com/joyent/node/wiki/Installation

* Install [npm](http://npmjs.org)

curl http://npmjs.org/install.sh | sudo sh

* After installation configure `NODE_PATH`:

echo 'export NODE_PATH="'$(npm root -g)'"'>> ~/.bashrc && . ~/.bashrc

or

echo 'export NODE_PATH="'$(npm root -g)'"'>> ~/.zshrc && . ~/.zshrc

* Install [bem-tools](https://github.com/bem/bem-tools)

sudo npm -g install bem

* Use this command [bem-tools](https://github.com/bem/bem-tools) to install the development version

sudo npm -g install bem@unstable

### bem-bl

If you are going to use `bem` with
[bem-bl](https://github.com/bem/bem-bl) block library, you should also install
[XJST](https://github.com/veged/xjst) and [OmetaJS](https://github.com/veged/ometa-js).

sudo npm -g install xjst ometajs
Run `npm install bem` to install `bem-tools` locally.

## Usage
Get the list of commands with `bem --help`.
Expand Down Expand Up @@ -280,6 +249,8 @@ You may use it to create a bundle that you request by application.
##### bem make
`make` command implements the build process of the BEM projects. You don't have to write your own scripts or makefiles (for GNU make or other build system) to build your BEM project.

Since `0.10.0` `bem make` also supports `enb make` under the hood which is recomended way to build your projects.

During the build `bem make`

* fetches the block libraries
Expand Down Expand Up @@ -310,8 +281,14 @@ When requested URL is mapped to a directory, the server will check if there is a
In the case one of these is true the content of the file will be returned to browser. The directory content listing will be returned
otherwise.

Since `0.10.0` `bem server` also supports `enb server` under the hood which is recomended way to build your projects.

#### Build configuration

Since `0.10.0` `bem make` and `bem server` also supports `ENB` under the hood which is recomended way to build your projects. So for build configuration please refer [ENB documentation](https://github.com/enb-make/enb).

The info about configuration bellow is deprecated and will be removed in the next version.

There is a default build behavior programmed in the build system. The configuration files allow to adjust it a little or change it completely.
To make `bem make` work you should have `.bem/level.js` file within your levels. It should contain the `getTechs()` function,
which returns object with the tech definitions used on the level.
Expand Down
45 changes: 10 additions & 35 deletions README.ru.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,10 @@
# БЭМ-инструменты
Работа с файлами, написанными по [БЭМ-методу](http://bem.github.com/bem-method/pages/beginning/beginning.en.html).
Работа с файлами, написанными по [БЭМ-методу](https://en.bem.info/method/).

## Установка
Вам потребуется [NodeJS 0.6+](http://nodejs.org/) или выше и [npm 1.x](http://npmjs.org/).
После этого достаточно `npm -g install bem`.

* Установить [nodejs](http://nodejs.org)

https://github.com/joyent/node/wiki/Installation

* Установить [npm](http://npmjs.org)

curl http://npmjs.org/install.sh | sudo sh

* После установки сконфигурируйте `NODE_PATH`:

echo 'export NODE_PATH="'$(npm root -g)'"'>> ~/.bashrc && . ~/.bashrc

или

echo 'export NODE_PATH="'$(npm root -g)'"'>> ~/.zshrc && . ~/.zshrc

* Установить [bem-tools](https://github.com/bem/bem-tools)

sudo npm -g install bem

* Для установки самой последней версии [bem-tools](https://github.com/bem/bem-tools) воспользуйтесь командой

sudo npm -g install bem@unstable

### bem-bl

Если вы планируете использовать `bem` вместе с библиотекой блоков
[bem-bl](https://github.com/bem/bem-bl), установите так же
[xjst](https://github.com/veged/xjst) и [ometajs](https://github.com/veged/ometa-js).

sudo npm -g install xjst ometajs
```sh
npm install bem
```

## Использование
Всю информацию о параметрах использования можно получить с помощью `bem --help`.
Expand Down Expand Up @@ -282,6 +251,8 @@
##### bem make
В команде `make` реализована сборка БЭМ проектов. Узнать больше о системах сборки можно из доклада Сергея Белова http://clubs.ya.ru/yasubbotnik/replies.xml?item_no=406.

С версии `0.10.0` `bem make` поддерживает также конфиги `ENB`, что является рекомендуемым способом сборки.

`bem make` собирает проект

* подключает библиотеки блоков
Expand All @@ -297,6 +268,8 @@

##### bem server

С версии `0.10.0` `bem server` поддерживает также конфиги `ENB`, что является рекомендуемым способом сборки.

`bem server` веб-сервер разработчика, который делает доступными по http протоколу файлы, собранные на лету bem make. bem server может быть вам полезен для разработки статических страниц по bem методу. Вы просто вносите изменения в файлы проекта, обновляете страницу в браузере и видите новый результат — файлы, которые затронули ваши изменения, будут автоматически пересобраны. Если же в вашем проекте нет статических страниц, вы можете настроить бэкенд и окружение таким образом, чтобы он обращался к bem server за файлами стилей и скриптов. bem server позволяет общаться с ним через привычный TCP socket или через UNIX domain socket.

По умолчанию корневым каталогом веб-сервера считается текущая директория. Вы можете указать нужный каталог с помощью
Expand All @@ -310,6 +283,8 @@ TCP порт по умолчанию, который слушает сервер

#### Конфигурирование сборки

С версии `0.10.0` `bem server` поддерживает также конфиги `ENB`, что является рекомендуемым способом сборки. Конфигурация, описываемая ниже, объявлена устаревшей и будет удалена в следующей версии.

В системе сборки предусмотрено некоторое поведение по умолчанию. С помощью файлов конфигурации можно как немного изменить
его, так и кардинально переделать. Необходимым минимумом для работы bem make являются конфиги `.bem/level.js` на уровнях
переопределения с функцией `getTechs()`, возвращающей массив технологий, задействованных на уровне. И функцией `getConfig()`:
Expand Down

0 comments on commit 13b7bef

Please sign in to comment.