diff --git a/README.md b/README.md index 17e74e4e..a7d90432 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ Project-stub is a template project repository used for BEM projects creation. It There are two main BEM libraries are linked here by default: -* [bem-core](https://github.com/bem/bem-core) -* [bem-components](https://github.com/bem/bem-components) +* [bem-core](https://en.bem.info/libs/bem-core/) +* [bem-components](https://en.bem.info/libs/bem-components/) ## Installation requirements @@ -25,7 +25,7 @@ So, how easy is it to get started with BEM? — *Super easy!* It's as easy as... ``` -git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.0.0 my-bem-project +git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.1.0 my-bem-project cd my-bem-project npm install # Do not use root rights to install npm and bower dependencies. ``` @@ -34,46 +34,30 @@ bower dependencies are installed in the `libs` directory by `npm postinstall`. ## Usage -You could use the following tools to build the project: [ENB](https://ru.bem.info/tools/bem/enb-bem-techs/)(only in Russian) or [bem-tools](https://bem.info/tools/bem/bem-tools/). The result files are the same in both cases. +You could use the following tools to build the project: [ENB](https://ru.bem.info/tools/bem/enb-bem-techs/)(only in Russian) or [bem-tools](https://bem.info/tools/bem/bem-tools/). The result files are the same in both cases as `bem-tools` just calls `ENB` under the hood. You can run any `enb` commands from a `node_modules/.bin/enb` directory and the `bem-tools` commands from `node_modules/bem/bin/bem`. -### Build the project with ENB +### Build the project ```bash node_modules/.bin/enb make ``` - -To be able to run `enb` commands without typing a full path to an executable file (`node_modules/.bin/enb`), use: - -``` -export PATH=./node_modules/.bin:$PATH` -``` - -Now you can use `enb` from any point of your project. - -``` -enb make -``` - -### Build the project with bem-tools - -To be able to run bem-tools commands without typing a full path to an executable file (`node_modules/bem/bin/bem`), use `bem-cli` npm package: - -``` -npm install -g bem-cli +or +```bash +node_modules/.bin/bem make ``` -The alternative method: +To be able to run commands without typing a full path to an executable file (`node_modules/.bin/enb`), use: ``` export PATH=./node_modules/.bin:$PATH` ``` -Now you can use `bem-tools` from any point of your project. +Now you can use `enb` or `bem` from any point of your project. ``` -bem make +enb make ``` ### The basic commands @@ -85,28 +69,26 @@ You could use help option to get information about the basic commands of `enb` a ``` enb -h ``` -и +and ``` bem -h ``` -**Start the server with ENB** +**Start the dev server** ```bash node_modules/.bin/enb server ``` - -You could use the `npm start` command to start the `enb server` without specifying the full path to the `node_modules`. - +or ```bash -npm start +node_modules/.bin/bem server ``` -**Start the server with bem-tools** +You could use the `npm start` command to start the `enb server` without specifying the full path to the `node_modules`. ```bash -bem server +npm start ``` The `bem server ` is running. To check it out, navigate to `http://localhost:8080/desktop.bundles/index/index.html`. @@ -158,7 +140,6 @@ This generator provides you the ability to get the base of BEM project in few mi ## Useful tools -- [bem-cli](https://en.bem.info/blog/bem-cli/) — run bem-tools locally - [borschik](https://en.bem.info/tools/optimizers/borschik/) — borschik is a simple but powerful builder for text-based file formats ## Videos diff --git a/README.ru.md b/README.ru.md index f43b2c61..abd0cdec 100644 --- a/README.ru.md +++ b/README.ru.md @@ -3,8 +3,8 @@ [Project-stub](https://github.com/bem/project-stub) – это шаблонный репозиторий для создания БЭМ-проектов. Он содержит необходимый минимум конфигурационных файлов и папок, который позволяет быстро развернуть проект с нуля. В project-stub по умолчанию подключены основные БЭМ-библиотеки: -* [bem-core](https://github.com/bem/bem-core) -* [bem-components](https://github.com/bem/bem-components) +* [bem-core](https://ru.bem.info/libs/bem-core/) +* [bem-components](https://ru.bem.info/libs/bem-components/) ## Требования к установке @@ -24,58 +24,39 @@ Клонируем репозиторий и устанавливаем все необходимые зависимости: ``` -git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.0.0 my-bem-project +git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.1.0 my-bem-project cd my-bem-project npm install # Не используйте права суперпользователя (`root`) при установке npm- и bower-зависимостей. ``` -bower-зависимости устанавливаются при выполнении `npm postinstall` в папку `libs`. +bower-зависимости автоматически устанавливаются при выполнении `npm postinstall` в папку `libs`. ## Практическое применение -Собрать проект можно с помощью [ENB](https://bem.info/tools/bem/enb-bem-techs/) или [bem-tools](https://ru.bem.info/tools/bem/bem-tools/). Результаты сборки в обоих случаях одинаковы. +Собрать проект можно с помощью [ENB](https://bem.info/tools/bem/enb-bem-techs/) или [bem-tools](https://ru.bem.info/tools/bem/bem-tools/). Результаты сборки в обоих случаях одинаковы, т.к. `bem-tools` просто проксирует вызовы к `ENB`. Вызов всех команд `enb` возможен из папки `node_modules/.bin/enb`, а команд `bem-tools` из `./node_modules/bem/bin/bem`. -### Сборка проекта с ENB +### Сборка проекта ```bash node_modules/.bin/enb make ``` - -Чтобы не указывать путь к исполняемому файлу (`node_modules/.bin/enb`) используйте: - -``` -export PATH=./node_modules/.bin:$PATH` -``` - -Теперь сборка доступна из любой точки проекта: - -``` -enb make -``` - -### Сборка проекта с bem-tools - +либо ``` ./node_modules/bem/bin/bem make ``` -Установите npm-пакет `bem-cli`, чтобы не указывать путь к исполняемому файлу (`./node_modules/bem/bin/bem`): - -``` -npm install -g bem-cli -``` - -Или используйте альтернативный метод: +Чтобы не указывать путь к исполняемому файлу (`node_modules/.bin/enb`) используйте: ``` export PATH=./node_modules/.bin:$PATH` ``` + Теперь сборка доступна из любой точки проекта: ``` -bem make +enb make ``` ### Базовые команды для обоих сборщиков @@ -93,22 +74,20 @@ enb -h bem -h ``` -**Старт сервера с ENB** +**Старт сервера** ```bash node_modules/.bin/enb server ``` - -Команда `npm start` также запускает `enb server`, при этом нет необходимости указывать полный путь до `node_modules`. - +либо ```bash -npm start +bem server ``` -**Старт сервера с bem-tools** +Команда `npm start` также запускает `enb server`, при этом нет необходимости указывать полный путь до `node_modules`. ```bash -bem server +npm start ``` На вашем компьютере запустился сервер для разработки. Чтобы проверить это, откройте в браузере `http://localhost:8080/desktop.bundles/index/index.html`. @@ -137,7 +116,7 @@ echo "alias 'bempage'='bem create -l desktop.bundles -b'" >> ~/.bashrc ## Генератор БЭМ-проектов на Yeoman -`project-stub` – это универсальный проект-заготовка, покрывающий большинство стандартных задач БЭМ-проекта. Если вам необходимо создать оптимальную конфигурацию вашего проекта, воспользуйтесь инструментом [generator-bem-stub](https://ru.bem.info/tools/bem/bem-stub/). +`project-stub` – это универсальный проект-заготовка, покрывающий большинство стандартных задач БЭМ-проекта. Если вам необходимо создать уникальную конфигурацию вашего проекта, воспользуйтесь инструментом [generator-bem-stub](https://ru.bem.info/tools/bem/bem-stub/). * Видео [генератор БЭМ-проектов на Yeoman](https://ru.bem.info/talks/bemup-moscow-2014/#Генератор-БЭМ-проектов-на-Yeoman-—-Евгений-Гаврюшин) @@ -159,7 +138,6 @@ echo "alias 'bempage'='bem create -l desktop.bundles -b'" >> ~/.bashrc ## Полезные инструменты -* [bem-cli](https://ru.bem.info/blog/bem-cli/) — запусти bem-tools локально * [borschik](https://ru.bem.info/tools/optimizers/borschik/) — простой, но мощный сборщик файлов текстовых форматов ## Видео