Skip to content

Commit 6e885ac

Browse files
authored
Merge pull request #2311 from BoostIO/update-build-document
Update build documents
2 parents 9e3b321 + 9ef07ce commit 6e885ac

File tree

8 files changed

+36
-123
lines changed

8 files changed

+36
-123
lines changed

docs/build.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) and [German](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md).
33

44
## Environments
5-
* npm: 4.x
6-
* node: 7.x
75

8-
You should use `npm v4.x` because `$ grunt pre-build` fails on `v5.x`.
6+
* npm: 6.x
7+
* node: 8.x
98

109
## Development
1110

@@ -21,17 +20,9 @@ $ yarn
2120
Build and run.
2221

2322
```
24-
$ yarn run dev-start
23+
$ yarn run dev
2524
```
2625

27-
This command runs `yarn run webpack` and `yarn run hot` in parallel. It is the same as running these commands in two terminals.
28-
29-
The `webpack` will watch for code changes and then apply them automatically.
30-
31-
If the following error occurs: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, please reload Boostnote.
32-
33-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
34-
3526
> ### Notice
3627
> There are some cases where you have to refresh the app manually.
3728
> 1. When editing a constructor method of a component
@@ -44,8 +35,6 @@ You can build the program by using `grunt`. However, we don't recommend this bec
4435

4536
So, we've prepared a separate script which just makes an executable file.
4637

47-
This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it.
48-
4938
```
5039
grunt pre-build
5140
```

docs/de/build.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
Diese Seite ist auch verfügbar in [Japanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Koreanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Vereinfachtem Chinesisch](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [Französisch](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) und [Deutsch](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md).
33

44
## Umgebungen
5-
* npm: 4.x
6-
* node: 7.x
75

8-
Du solltest `npm v4.x` benutzen weil `$ grunt pre-build` scheitert mit Version `v5.x`.
6+
* npm: 6.x
7+
* node: 8.x
98

109
## Entwicklung
1110

@@ -21,17 +20,9 @@ $ yarn
2120
Bauen und Ausführen.
2221

2322
```
24-
$ yarn run dev-start
23+
$ yarn run dev
2524
```
2625

27-
Dieser Befehl startet `yarn run webpack` und `yarn run hot` parallel. Es hat den selben Effekt wie beide Befehle separat in zwei Terminals zu starten.
28-
29-
Das `webpack` überprüft den Code auf Änderungen und wendet diese dann automatisch an.
30-
31-
Wenn folgender Fehler passiert: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, bitte Boostnote neu starten.
32-
33-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
34-
3526
> ### Notiz
3627
> Es gibt einige Fälle bei denen die App manuell zu refreshen ist.
3728
> 1. Wenn eine "constructor method" einer Komponente manuell editiert wird.
@@ -44,11 +35,10 @@ Du kannst das Programm unter Verwendung von `grunt` bauen. Jedoch empfehlen wir
4435

4536
Deshalb haben wir ein separates Script vorbereitet welches eine ausführbare Datei erstellt.
4637

47-
Dieser build funktioniert nicht mit npm v5.3.0. Deshalb musst du für den Build die Version v5.2.0 verwenden.
48-
4938
```
5039
grunt pre-build
5140
```
41+
5242
Du findest die ausführbare Datein in dem Verzeichnis `dist`. Beachte, der auto updater funktioniert nicht da die app nicht signiert ist.
5343

5444
Wenn du es für notwendig erachtest, kannst du codesign or authenticode mit dieser ausführbaren Datei verwenden.

docs/fr/build.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
Cette page est également disponible en [Anglais](https://github.com/BoostIO/Boostnote/blob/master/docs/build.md), [Japonais](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Coréen](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russe](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Chinois Simplifié](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md) et en [Allemand](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md)
33

44
## Environnements
5-
* npm: 4.x
6-
* node: 7.x
75

8-
Il est conseillé d'utiliser `npm v4.x` car `$ grunt pre-build` ne marche pas sur la `v5.x`.
6+
* npm: 6.x
7+
* node: 8.x
98

109
## Développement
1110

@@ -20,17 +19,9 @@ $ yarn
2019
Build et start
2120

2221
```
23-
$ yarn run dev-start
22+
$ yarn run dev
2423
```
2524

26-
Cette commande lance `yarn run webpack` et `yarn run hot` en parallèle. Cela revient au même que si on utilisait ces deux commandes dans 2 terminaux.
27-
28-
La commande `webpack` va surveiller les changements de code et les appliquer automatiquement.
29-
30-
Si l'erreur suivante apparait : `Failed to load resource: net::ERR_CONNECTION_REFUSED`, relancez Boostnote.
31-
32-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
33-
3425
> ### Notice
3526
> Il y a certains cas où vous voudrez relancer l'application manuellement.
3627
> 1. Quand vous éditez la méthode constructeur dans un composant
@@ -43,8 +34,6 @@ Vous pouvez build le programme en utilisant `grunt`. Cependant, nous ne recomman
4334

4435
Nous avons donc préparé un script séparé qui va rendre un fichier exécutable.
4536

46-
Le build ne fonctionne pas sur `npm v5.3.0`. Il faut donc utiliser `npm v5.2.0` quand vous faites le build.
47-
4837
```
4938
grunt pre-build
5039
```

docs/jp/build.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Build
22

33
## 環境
4-
* npm: 4.x
5-
* node: 7.x
64

7-
`npm v5.x` だと `$ grunt pre-build` が失敗するので、 `npm v4.x` を使用してください。
5+
* npm: 6.x
6+
* node: 8.x
87

98
## 開発
109

@@ -21,17 +20,9 @@ $ yarn
2120
ビルドして実行します。
2221

2322
```
24-
$ yarn run dev-start
23+
$ yarn run dev
2524
```
2625

27-
このコマンドは `yarn run webpack``yarn run hot`を並列に実行します。つまりこのコマンドは2つのターミナルで同時にこれらのコマンドを実行するのと同じことです。
28-
29-
そして、Webpackが自動的にコードの変更を確認し、それを適用してくれるようになります。
30-
31-
もし、 `Failed to load resource: net::ERR_CONNECTION_REFUSED`というエラーが起きた場合、Boostnoteをリロードしてください。
32-
33-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
34-
3526
> ### 注意
3627
> 時々、直接リフレッシュをする必要があります。
3728
> 1. コンポーネントのコンストラクタ関数を編集する場合
@@ -44,8 +35,6 @@ Gruntを使います。
4435

4536
代わりに、実行ファイルを作るスクリプトを用意しておきました。
4637

47-
このビルドはnpm v5.3.0では動かないのでv5.2.0で動かす必要があります。
48-
4938
```
5039
grunt pre-build
5140
```

docs/ko/build.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Build
22

33
## 환경
4-
* npm: 4.x
5-
* node: 7.x
4+
5+
* npm: 6.x
6+
* node: 8.x
67

78
`$ grunt pre-build``npm v5.x`에서 실행할 수 없기 때문에, 반드시 `npm v4.x`를 사용하셔야 합니다.
89

@@ -20,17 +21,9 @@ $ yarn
2021
그 다음, 아래의 명령으로 빌드를 끝내고 자동적으로 어플리케이션을 실행합니다.
2122

2223
```
23-
$ yarn run dev-start
24+
$ yarn run dev
2425
```
2526

26-
이 명령은 `yarn run webpack``yarn run hot`을 동시에 실행합니다. 이는 두개의 터미널에서 각각의 명령을 동시에 실행하는 것과 같습니다.
27-
28-
`Webpack`은 코드의 변화를 자동으로 탐지하여 적용시키는 역할을 합니다.
29-
30-
만약, `Failed to load resource: net::ERR_CONNECTION_REFUSED`과 같은 에러가 나타난다면 Boostnote를 리로드해주세요.
31-
32-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
33-
3427
> ### 주의
3528
> 가끔 직접 리프레쉬를 해주어야 하는 경우가 있습니다.
3629
> 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우
@@ -43,8 +36,6 @@ Boostnote에서는 배포 자동화를 위하여 그런트를 사용합니다.
4336

4437
그래서, 실행파일만을 만드는 스크립트를 준비해 뒀습니다.
4538

46-
이 빌드는 npm v5.3.0에서는 작동하지 않습니다. 그러므로, 성공적으로 빌드하기 위해서는 v5.2.0을 사용해야 합니다.
47-
4839
```
4940
grunt pre-build
5041
```

docs/ru/build.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Сборка
22

33
## Используемые инструменты
4-
* npm: 4.x
5-
* node: 7.x
64

7-
Вы должны использовать `npm v4.x`, так как `$ grunt pre-build` не работает в `v5.x`.
5+
* npm: 6.x
6+
* node: 8.x
87

98
## Разработка
109

@@ -20,17 +19,9 @@ $ yarn
2019
Соберите и запустите.
2120

2221
```
23-
$ yarn run dev-start
22+
$ yarn run dev
2423
```
2524

26-
Эта команда выполняет `yarn run webpack` и `yarn run hot` параллельно. Результат будет такой же, если вы выполните эти две команды раздельно.
27-
28-
`Webpack` будет следить за изменениями в коде и будет применять их автоматически.
29-
30-
Если возникает следующая ошибка: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, пожалуйста, перезапустите Boostnote.
31-
32-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
33-
3425
> ### Примечание
3526
> В некоторых случаях вам необходимо обновить приложение вручную.
3627
> 1. При редактировании метода конструктора компонента
@@ -41,9 +32,7 @@ $ yarn run dev-start
4132
Мы используем Grunt для автоматического деплоя.
4233
Вы можете создать задачу, используя `grunt`. Однако мы не рекомендуем этого делать, так как задача по умолчанию включает в себя код и аутентификацию.
4334

44-
Мы подготовили отдельный скрипт, который просто создает исполняемый файл:
45-
46-
This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it.
35+
Мы подготовили отдельный скрипт, который просто создает исполняемый файл.
4736

4837
```
4938
grunt pre-build

docs/zh_CN/build.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,44 @@
11
# 构建Boostnote
22

33
## 环境
4-
* npm: 4.x
5-
* node: 7.x
64

7-
因为`$ grunt pre-build`的问题,您只能使用`npm v4.x`而不能使用`npm v5.x`
5+
* npm: 6.x
6+
* node: 8.x
87

98
## 开发
109

11-
我们使用Webpack HMR来开发Boostnote。
12-
在代码根目录下运行下列指令可以以默认配置运行Boostnote。
10+
我们使用Webpack HMR来开发Boostnote。
11+
在代码根目录下运行下列指令可以以默认配置运行Boostnote。
1312

14-
### 首先使用yarn安装所需的依赖包。
13+
### 首先使用yarn安装所需的依赖包。
1514

1615
```
1716
$ yarn
1817
```
1918

20-
### 接着编译并且运行Boostnote。
19+
### 接着编译并且运行Boostnote。
2120

2221
```
23-
$ yarn run dev-start
22+
$ yarn run dev
2423
```
2524

26-
这个指令相当于在两个终端内同时运行`yarn run webpack``yarn run hot`
27-
28-
如果出现错误`Failed to load resource: net::ERR_CONNECTION_REFUSED`,请尝试重新运行Boostnote。
29-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
30-
31-
### 然后您就可以进行开发了
32-
33-
当您对代码作出更改的时候,`webpack`会自动抓取并应用所有代码更改。
34-
3525
> ### 提示
3626
> 在如下情况中,您可能需要重新运行Boostnote才能应用代码更改
3727
> 1. 当您在修改了一个组件的构造函数的时候When editing a constructor method of a component
3828
> 2. 当您新建了一个CSS类的时候(其实这和第1项是相同的,因为每个CSS类都需在组件的构造函数中被重写)
3929
4030
## 部署
4131

42-
我们使用Grunt来自动部署Boostnote。
43-
因为部署需要协同设计(codesign)与验证码(authenticode),所以您可以但我们不建议通过`grunt`来部署。
44-
所以我们准备了一个脚本文件来生成执行文件。
32+
我们使用Grunt来自动部署Boostnote。
33+
因为部署需要协同设计(codesign)与验证码(authenticode),所以您可以但我们不建议通过`grunt`来部署。
34+
所以我们准备了一个脚本文件来生成执行文件。
4535

4636
```
4737
grunt pre-build
4838
```
4939

50-
您只能使用`npm v5.2.0`而不能使用`npm v5.3.0`
51-
52-
接下来您就可以在`dist`目录中找到可执行文件。
40+
接下来您就可以在`dist`目录中找到可执行文件。
5341

5442
> ### 提示
5543
> 因为此可执行文件并没有被注册,所以自动更新不可用。
56-
> 如果需要,您也可将协同设计(codesign)与验证码(authenticode)使用于这个可执行文件中。
44+
> 如果需要,您也可将协同设计(codesign)与验证码(authenticode)使用于这个可执行文件中。

docs/zh_TW/build.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
此文件還提供下列的語言 [日文](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [韓文](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [俄文](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [簡體中文](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [法文](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) and [德文](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md).
33

44
## 環境
5-
* npm: 4.x
6-
* node: 7.x
75

8-
`$ grunt pre-build``npm v5.x` 有問題,所以只能用 `npm v4.x`
6+
* npm: 6.x
7+
* node: 8.x
98

109
## 開發
1110

@@ -22,18 +21,9 @@ $ yarn
2221
**開始開發**
2322

2423
```
25-
$ yarn run dev-start
24+
$ yarn run dev
2625
```
2726

28-
上述指令同時運行了 `yarn run webpack``yarn run hot`,相當於將這兩個指令在不同的 terminal 中運行。
29-
30-
`webpack` 會同時監控修改過的程式碼,並
31-
The `webpack` will watch for code changes and then apply them automatically.
32-
33-
If the following error occurs: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, please reload Boostnote.
34-
35-
![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png)
36-
3727
> ### Notice
3828
> There are some cases where you have to refresh the app manually.
3929
> 1. When editing a constructor method of a component
@@ -46,8 +36,6 @@ You can build the program by using `grunt`. However, we don't recommend this bec
4636

4737
So, we've prepared a separate script which just makes an executable file.
4838

49-
This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it.
50-
5139
```
5240
grunt pre-build
5341
```

0 commit comments

Comments
 (0)