Skip to content

Commit 1d92274

Browse files
committed
Update readme
1 parent 3564494 commit 1d92274

File tree

2 files changed

+33
-74
lines changed

2 files changed

+33
-74
lines changed

README.md

+17-36
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Project-stub is a template project repository used for BEM projects creation. It
44

55
There are two main BEM libraries are linked here by default:
66

7-
* [bem-core](https://github.com/bem/bem-core)
8-
* [bem-components](https://github.com/bem/bem-components)
7+
* [bem-core](https://en.bem.info/libs/bem-core/)
8+
* [bem-components](https://en.bem.info/libs/bem-components/)
99

1010
## Installation requirements
1111

@@ -25,7 +25,7 @@ So, how easy is it to get started with BEM? — *Super easy!*
2525
It's as easy as...
2626

2727
```
28-
git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.0.0 my-bem-project
28+
git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.1.0 my-bem-project
2929
cd my-bem-project
3030
npm install # Do not use root rights to install npm and bower dependencies.
3131
```
@@ -34,46 +34,30 @@ bower dependencies are installed in the `libs` directory by `npm postinstall`.
3434

3535
## Usage
3636

37-
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.
37+
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.
3838

3939
You can run any `enb` commands from a `node_modules/.bin/enb` directory and the `bem-tools` commands from `node_modules/bem/bin/bem`.
4040

41-
### Build the project with ENB
41+
### Build the project
4242

4343
```bash
4444
node_modules/.bin/enb make
4545
```
46-
47-
To be able to run `enb` commands without typing a full path to an executable file (`node_modules/.bin/enb`), use:
48-
49-
```
50-
export PATH=./node_modules/.bin:$PATH`
51-
```
52-
53-
Now you can use `enb` from any point of your project.
54-
55-
```
56-
enb make
57-
```
58-
59-
### Build the project with bem-tools
60-
61-
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:
62-
63-
```
64-
npm install -g bem-cli
46+
or
47+
```bash
48+
node_modules/.bin/bem make
6549
```
6650

67-
The alternative method:
51+
To be able to run commands without typing a full path to an executable file (`node_modules/.bin/enb`), use:
6852

6953
```
7054
export PATH=./node_modules/.bin:$PATH`
7155
```
7256

73-
Now you can use `bem-tools` from any point of your project.
57+
Now you can use `enb` or `bem` from any point of your project.
7458

7559
```
76-
bem make
60+
enb make
7761
```
7862

7963
### The basic commands
@@ -85,28 +69,26 @@ You could use help option to get information about the basic commands of `enb` a
8569
```
8670
enb -h
8771
```
88-
и
72+
and
8973

9074
```
9175
bem -h
9276
```
9377

94-
**Start the server with ENB**
78+
**Start the dev server**
9579

9680
```bash
9781
node_modules/.bin/enb server
9882
```
99-
100-
You could use the `npm start` command to start the `enb server` without specifying the full path to the `node_modules`.
101-
83+
or
10284
```bash
103-
npm start
85+
node_modules/.bin/bem server
10486
```
10587

106-
**Start the server with bem-tools**
88+
You could use the `npm start` command to start the `enb server` without specifying the full path to the `node_modules`.
10789

10890
```bash
109-
bem server
91+
npm start
11092
```
11193

11294
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
158140

159141
## Useful tools
160142

161-
- [bem-cli](https://en.bem.info/blog/bem-cli/) — run bem-tools locally
162143
- [borschik](https://en.bem.info/tools/optimizers/borschik/) — borschik is a simple but powerful builder for text-based file formats
163144

164145
## Videos

README.ru.md

+16-38
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
[Project-stub](https://github.com/bem/project-stub) – это шаблонный репозиторий для создания БЭМ-проектов. Он содержит необходимый минимум конфигурационных файлов и папок, который позволяет быстро развернуть проект с нуля.
44
В project-stub по умолчанию подключены основные БЭМ-библиотеки:
55

6-
* [bem-core](https://github.com/bem/bem-core)
7-
* [bem-components](https://github.com/bem/bem-components)
6+
* [bem-core](https://ru.bem.info/libs/bem-core/)
7+
* [bem-components](https://ru.bem.info/libs/bem-components/)
88

99
## Требования к установке
1010

@@ -24,58 +24,39 @@
2424
Клонируем репозиторий и устанавливаем все необходимые зависимости:
2525

2626
```
27-
git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.0.0 my-bem-project
27+
git clone https://github.com/bem/project-stub.git --depth 1 --branch v1.1.0 my-bem-project
2828
cd my-bem-project
2929
npm install # Не используйте права суперпользователя (`root`) при установке npm- и bower-зависимостей.
3030
```
3131

32-
bower-зависимости устанавливаются при выполнении `npm postinstall` в папку `libs`.
32+
bower-зависимости автоматически устанавливаются при выполнении `npm postinstall` в папку `libs`.
3333

3434
## Практическое применение
3535

36-
Собрать проект можно с помощью [ENB](https://bem.info/tools/bem/enb-bem-techs/) или [bem-tools](https://ru.bem.info/tools/bem/bem-tools/). Результаты сборки в обоих случаях одинаковы.
36+
Собрать проект можно с помощью [ENB](https://bem.info/tools/bem/enb-bem-techs/) или [bem-tools](https://ru.bem.info/tools/bem/bem-tools/). Результаты сборки в обоих случаях одинаковы, т.к. `bem-tools` просто проксирует вызовы к `ENB`.
3737

3838
Вызов всех команд `enb` возможен из папки `node_modules/.bin/enb`, а команд `bem-tools` из `./node_modules/bem/bin/bem`.
3939

40-
### Сборка проекта с ENB
40+
### Сборка проекта
4141

4242
```bash
4343
node_modules/.bin/enb make
4444
```
45-
46-
Чтобы не указывать путь к исполняемому файлу (`node_modules/.bin/enb`) используйте:
47-
48-
```
49-
export PATH=./node_modules/.bin:$PATH`
50-
```
51-
52-
Теперь сборка доступна из любой точки проекта:
53-
54-
```
55-
enb make
56-
```
57-
58-
### Сборка проекта с bem-tools
59-
45+
либо
6046
```
6147
./node_modules/bem/bin/bem make
6248
```
6349

64-
Установите npm-пакет `bem-cli`, чтобы не указывать путь к исполняемому файлу (`./node_modules/bem/bin/bem`):
65-
66-
```
67-
npm install -g bem-cli
68-
```
69-
70-
Или используйте альтернативный метод:
50+
Чтобы не указывать путь к исполняемому файлу (`node_modules/.bin/enb`) используйте:
7151

7252
```
7353
export PATH=./node_modules/.bin:$PATH`
7454
```
55+
7556
Теперь сборка доступна из любой точки проекта:
7657

7758
```
78-
bem make
59+
enb make
7960
```
8061

8162
### Базовые команды для обоих сборщиков
@@ -93,22 +74,20 @@ enb -h
9374
bem -h
9475
```
9576

96-
**Старт сервера с ENB**
77+
**Старт сервера**
9778

9879
```bash
9980
node_modules/.bin/enb server
10081
```
101-
102-
Команда `npm start` также запускает `enb server`, при этом нет необходимости указывать полный путь до `node_modules`.
103-
82+
либо
10483
```bash
105-
npm start
84+
bem server
10685
```
10786

108-
**Старт сервера с bem-tools**
87+
Команда `npm start` также запускает `enb server`, при этом нет необходимости указывать полный путь до `node_modules`.
10988

11089
```bash
111-
bem server
90+
npm start
11291
```
11392

11493
На вашем компьютере запустился сервер для разработки. Чтобы проверить это, откройте в браузере `http://localhost:8080/desktop.bundles/index/index.html`.
@@ -137,7 +116,7 @@ echo "alias 'bempage'='bem create -l desktop.bundles -b'" >> ~/.bashrc
137116

138117
## Генератор БЭМ-проектов на Yeoman
139118

140-
`project-stub` – это универсальный проект-заготовка, покрывающий большинство стандартных задач БЭМ-проекта. Если вам необходимо создать оптимальную конфигурацию вашего проекта, воспользуйтесь инструментом [generator-bem-stub](https://ru.bem.info/tools/bem/bem-stub/).
119+
`project-stub` – это универсальный проект-заготовка, покрывающий большинство стандартных задач БЭМ-проекта. Если вам необходимо создать уникальную конфигурацию вашего проекта, воспользуйтесь инструментом [generator-bem-stub](https://ru.bem.info/tools/bem/bem-stub/).
141120

142121
* Видео [генератор БЭМ-проектов на Yeoman](https://ru.bem.info/talks/bemup-moscow-2014/#Генератор-БЭМ-проектов-на-Yeoman-—-Евгений-Гаврюшин)
143122

@@ -159,7 +138,6 @@ echo "alias 'bempage'='bem create -l desktop.bundles -b'" >> ~/.bashrc
159138

160139
## Полезные инструменты
161140

162-
* [bem-cli](https://ru.bem.info/blog/bem-cli/) — запусти bem-tools локально
163141
* [borschik](https://ru.bem.info/tools/optimizers/borschik/) — простой, но мощный сборщик файлов текстовых форматов
164142

165143
## Видео

0 commit comments

Comments
 (0)