From 9ef07cea7a50cf1bc2ba1a04b477675224b85d3b Mon Sep 17 00:00:00 2001 From: Junyoung Choi Date: Mon, 20 Aug 2018 15:19:40 +0900 Subject: [PATCH] Update build documents --- docs/build.md | 17 +++-------------- docs/de/build.md | 18 ++++-------------- docs/fr/build.md | 17 +++-------------- docs/jp/build.md | 17 +++-------------- docs/ko/build.md | 17 ++++------------- docs/ru/build.md | 19 ++++--------------- docs/zh_CN/build.md | 36 ++++++++++++------------------------ docs/zh_TW/build.md | 18 +++--------------- 8 files changed, 36 insertions(+), 123 deletions(-) diff --git a/docs/build.md b/docs/build.md index 08fd9ac5..f2b3e5ac 100644 --- a/docs/build.md +++ b/docs/build.md @@ -2,10 +2,9 @@ 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). ## Environments -* npm: 4.x -* node: 7.x -You should use `npm v4.x` because `$ grunt pre-build` fails on `v5.x`. +* npm: 6.x +* node: 8.x ## Development @@ -21,17 +20,9 @@ $ yarn Build and run. ``` -$ yarn run dev-start +$ yarn run dev ``` -This command runs `yarn run webpack` and `yarn run hot` in parallel. It is the same as running these commands in two terminals. - -The `webpack` will watch for code changes and then apply them automatically. - -If the following error occurs: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, please reload Boostnote. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### Notice > There are some cases where you have to refresh the app manually. > 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 So, we've prepared a separate script which just makes an executable file. -This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it. - ``` grunt pre-build ``` diff --git a/docs/de/build.md b/docs/de/build.md index 3c7c8ac6..a3d8e274 100644 --- a/docs/de/build.md +++ b/docs/de/build.md @@ -2,10 +2,9 @@ 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). ## Umgebungen -* npm: 4.x -* node: 7.x -Du solltest `npm v4.x` benutzen weil `$ grunt pre-build` scheitert mit Version `v5.x`. +* npm: 6.x +* node: 8.x ## Entwicklung @@ -21,17 +20,9 @@ $ yarn Bauen und Ausführen. ``` -$ yarn run dev-start +$ yarn run dev ``` -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. - -Das `webpack` überprüft den Code auf Änderungen und wendet diese dann automatisch an. - -Wenn folgender Fehler passiert: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, bitte Boostnote neu starten. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### Notiz > Es gibt einige Fälle bei denen die App manuell zu refreshen ist. > 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 Deshalb haben wir ein separates Script vorbereitet welches eine ausführbare Datei erstellt. -Dieser build funktioniert nicht mit npm v5.3.0. Deshalb musst du für den Build die Version v5.2.0 verwenden. - ``` grunt pre-build ``` + Du findest die ausführbare Datein in dem Verzeichnis `dist`. Beachte, der auto updater funktioniert nicht da die app nicht signiert ist. Wenn du es für notwendig erachtest, kannst du codesign or authenticode mit dieser ausführbaren Datei verwenden. diff --git a/docs/fr/build.md b/docs/fr/build.md index e4c9cd98..e66a11aa 100644 --- a/docs/fr/build.md +++ b/docs/fr/build.md @@ -2,10 +2,9 @@ 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) ## Environnements -* npm: 4.x -* node: 7.x -Il est conseillé d'utiliser `npm v4.x` car `$ grunt pre-build` ne marche pas sur la `v5.x`. +* npm: 6.x +* node: 8.x ## Développement @@ -20,17 +19,9 @@ $ yarn Build et start ``` -$ yarn run dev-start +$ yarn run dev ``` -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. - -La commande `webpack` va surveiller les changements de code et les appliquer automatiquement. - -Si l'erreur suivante apparait : `Failed to load resource: net::ERR_CONNECTION_REFUSED`, relancez Boostnote. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### Notice > Il y a certains cas où vous voudrez relancer l'application manuellement. > 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 Nous avons donc préparé un script séparé qui va rendre un fichier exécutable. -Le build ne fonctionne pas sur `npm v5.3.0`. Il faut donc utiliser `npm v5.2.0` quand vous faites le build. - ``` grunt pre-build ``` diff --git a/docs/jp/build.md b/docs/jp/build.md index b8d2e414..00fad165 100644 --- a/docs/jp/build.md +++ b/docs/jp/build.md @@ -1,10 +1,9 @@ # Build ## 環境 -* npm: 4.x -* node: 7.x -`npm v5.x` だと `$ grunt pre-build` が失敗するので、 `npm v4.x` を使用してください。 +* npm: 6.x +* node: 8.x ## 開発 @@ -21,17 +20,9 @@ $ yarn ビルドして実行します。 ``` -$ yarn run dev-start +$ yarn run dev ``` -このコマンドは `yarn run webpack` と `yarn run hot`を並列に実行します。つまりこのコマンドは2つのターミナルで同時にこれらのコマンドを実行するのと同じことです。 - -そして、Webpackが自動的にコードの変更を確認し、それを適用してくれるようになります。 - -もし、 `Failed to load resource: net::ERR_CONNECTION_REFUSED`というエラーが起きた場合、Boostnoteをリロードしてください。 - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### 注意 > 時々、直接リフレッシュをする必要があります。 > 1. コンポーネントのコンストラクタ関数を編集する場合 @@ -44,8 +35,6 @@ Gruntを使います。 代わりに、実行ファイルを作るスクリプトを用意しておきました。 -このビルドはnpm v5.3.0では動かないのでv5.2.0で動かす必要があります。 - ``` grunt pre-build ``` diff --git a/docs/ko/build.md b/docs/ko/build.md index 7bbe302f..17e9c712 100644 --- a/docs/ko/build.md +++ b/docs/ko/build.md @@ -1,8 +1,9 @@ # Build ## 환경 -* npm: 4.x -* node: 7.x + +* npm: 6.x +* node: 8.x `$ grunt pre-build`를 `npm v5.x`에서 실행할 수 없기 때문에, 반드시 `npm v4.x`를 사용하셔야 합니다. @@ -20,17 +21,9 @@ $ yarn 그 다음, 아래의 명령으로 빌드를 끝내고 자동적으로 어플리케이션을 실행합니다. ``` -$ yarn run dev-start +$ yarn run dev ``` -이 명령은 `yarn run webpack` 과 `yarn run hot`을 동시에 실행합니다. 이는 두개의 터미널에서 각각의 명령을 동시에 실행하는 것과 같습니다. - -`Webpack`은 코드의 변화를 자동으로 탐지하여 적용시키는 역할을 합니다. - -만약, `Failed to load resource: net::ERR_CONNECTION_REFUSED`과 같은 에러가 나타난다면 Boostnote를 리로드해주세요. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### 주의 > 가끔 직접 리프레쉬를 해주어야 하는 경우가 있습니다. > 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우 @@ -43,8 +36,6 @@ Boostnote에서는 배포 자동화를 위하여 그런트를 사용합니다. 그래서, 실행파일만을 만드는 스크립트를 준비해 뒀습니다. -이 빌드는 npm v5.3.0에서는 작동하지 않습니다. 그러므로, 성공적으로 빌드하기 위해서는 v5.2.0을 사용해야 합니다. - ``` grunt pre-build ``` diff --git a/docs/ru/build.md b/docs/ru/build.md index d106e482..8feebe5e 100644 --- a/docs/ru/build.md +++ b/docs/ru/build.md @@ -1,10 +1,9 @@ # Сборка ## Используемые инструменты -* npm: 4.x -* node: 7.x -Вы должны использовать `npm v4.x`, так как `$ grunt pre-build` не работает в `v5.x`. +* npm: 6.x +* node: 8.x ## Разработка @@ -20,17 +19,9 @@ $ yarn Соберите и запустите. ``` -$ yarn run dev-start +$ yarn run dev ``` -Эта команда выполняет `yarn run webpack` и `yarn run hot` параллельно. Результат будет такой же, если вы выполните эти две команды раздельно. - -`Webpack` будет следить за изменениями в коде и будет применять их автоматически. - -Если возникает следующая ошибка: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, пожалуйста, перезапустите Boostnote. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### Примечание > В некоторых случаях вам необходимо обновить приложение вручную. > 1. При редактировании метода конструктора компонента @@ -41,9 +32,7 @@ $ yarn run dev-start Мы используем Grunt для автоматического деплоя. Вы можете создать задачу, используя `grunt`. Однако мы не рекомендуем этого делать, так как задача по умолчанию включает в себя код и аутентификацию. -Мы подготовили отдельный скрипт, который просто создает исполняемый файл: - -This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it. +Мы подготовили отдельный скрипт, который просто создает исполняемый файл. ``` grunt pre-build diff --git a/docs/zh_CN/build.md b/docs/zh_CN/build.md index 9183ebb3..0fd83e27 100644 --- a/docs/zh_CN/build.md +++ b/docs/zh_CN/build.md @@ -1,37 +1,27 @@ # 构建Boostnote ## 环境 -* npm: 4.x -* node: 7.x -因为`$ grunt pre-build`的问题，您只能使用`npm v4.x`而不能使用`npm v5.x`。 +* npm: 6.x +* node: 8.x ## 开发 -我们使用Webpack HMR来开发Boostnote。 -在代码根目录下运行下列指令可以以默认配置运行Boostnote。 +我们使用Webpack HMR来开发Boostnote。 +在代码根目录下运行下列指令可以以默认配置运行Boostnote。 -### 首先使用yarn安装所需的依赖包。 +### 首先使用yarn安装所需的依赖包。 ``` $ yarn ``` -### 接着编译并且运行Boostnote。 +### 接着编译并且运行Boostnote。 ``` -$ yarn run dev-start +$ yarn run dev ``` -这个指令相当于在两个终端内同时运行`yarn run webpack`和`yarn run hot`。 - -如果出现错误`Failed to load resource: net::ERR_CONNECTION_REFUSED`，请尝试重新运行Boostnote。 -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - -### 然后您就可以进行开发了 - -当您对代码作出更改的时候，`webpack`会自动抓取并应用所有代码更改。 - > ### 提示 > 在如下情况中，您可能需要重新运行Boostnote才能应用代码更改 > 1. 当您在修改了一个组件的构造函数的时候When editing a constructor method of a component @@ -39,18 +29,16 @@ $ yarn run dev-start ## 部署 -我们使用Grunt来自动部署Boostnote。 -因为部署需要协同设计(codesign)与验证码(authenticode)，所以您可以但我们不建议通过`grunt`来部署。 -所以我们准备了一个脚本文件来生成执行文件。 +我们使用Grunt来自动部署Boostnote。 +因为部署需要协同设计(codesign)与验证码(authenticode)，所以您可以但我们不建议通过`grunt`来部署。 +所以我们准备了一个脚本文件来生成执行文件。 ``` grunt pre-build ``` -您只能使用`npm v5.2.0`而不能使用`npm v5.3.0`。 - -接下来您就可以在`dist`目录中找到可执行文件。 +接下来您就可以在`dist`目录中找到可执行文件。 > ### 提示 > 因为此可执行文件并没有被注册，所以自动更新不可用。 -> 如果需要，您也可将协同设计(codesign)与验证码(authenticode)使用于这个可执行文件中。 +> 如果需要，您也可将协同设计(codesign)与验证码(authenticode)使用于这个可执行文件中。 diff --git a/docs/zh_TW/build.md b/docs/zh_TW/build.md index ff17d9c5..65b086ac 100644 --- a/docs/zh_TW/build.md +++ b/docs/zh_TW/build.md @@ -2,10 +2,9 @@ 此文件還提供下列的語言 [日文](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). ## 環境 -* npm: 4.x -* node: 7.x -`$ grunt pre-build` 在 `npm v5.x` 有問題，所以只能用 `npm v4.x` 。 +* npm: 6.x +* node: 8.x ## 開發 @@ -22,18 +21,9 @@ $ yarn **開始開發** ``` -$ yarn run dev-start +$ yarn run dev ``` -上述指令同時運行了 `yarn run webpack` 及 `yarn run hot`，相當於將這兩個指令在不同的 terminal 中運行。 - -`webpack` 會同時監控修改過的程式碼，並 -The `webpack` will watch for code changes and then apply them automatically. - -If the following error occurs: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, please reload Boostnote. - -![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) - > ### Notice > There are some cases where you have to refresh the app manually. > 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 So, we've prepared a separate script which just makes an executable file. -This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it. - ``` grunt pre-build ```