1
0
mirror of https://github.com/BoostIo/Boostnote synced 2025-12-13 09:46:22 +00:00

update readme

This commit is contained in:
Dick Choi
2016-08-24 10:48:42 +09:00
parent 52d065a38d
commit 93dd97a14a
6 changed files with 170 additions and 0 deletions

44
docs/build.md Normal file
View File

@@ -0,0 +1,44 @@
# Build
## Development
We use Webpack HMR to develope Boostnote.
You can use this command to use our configuration
```
npm run webpack
```
After a few seconds, you will see this message.
```
webpack: bundle is now VALID.
```
Then, we have to run the app.
```
npm run hot
```
> Actually the app can be start with `npm start@. However, the app will use the compiled scpript.
By this, webpack will watch the code changes and apply it automatically.
> ### Notice
> There are some cases you have to refresh app yourself.
> 1. When editing constructor method of a component
> 2. When adding a new css class(same to 1: CSS classs is re-written by each component. This process occurs at Constructor method.)
## Deploy
We use Grunt.
Acutal deploy can be run by `grunt`. However, you shouldn't use because the default task is including codesign and authenticode.
So, we prepare a script which just make an excutable file.
```
grunt pre-build
```
You will find the excutable from `dist`. In this case, auto updater won't work because the app isn't signed.
If you are necessary, you can do codesign or authenticode by this excutable.

46
docs/jp/build.md Normal file
View File

@@ -0,0 +1,46 @@
# Build
## 開発
Webpack HRMを使います。
次の命令から私達がしておいた設定を使うことができます。
```
npm run webpack
```
数秒後、次のメッセージが表示されます。
```
webpack: bundle is now VALID.
```
では、アプリを起動します。
```
npm run hot
```
> 元々、アプリは`npm start`から起動できます。しかし、この場合、コンパイルされたスクリプトを利用します。
これにより、Webpackが自動的にコードの変更を確認し、それを適用してくれるようになります。
> ### 注意
> 時々、直接リフレッシュをする必要があります。
> 1. コンポネントのコンストラクター関数を編集する場合
> 2. 新しいCSSクラスを追加する場合(1.の理由と同じ: CSSクラス名はコンポネントごとに書きなおされまが、この作業はコンストラクターで行われます。)
## 配布
Gruntを使います。
実際の配布は`grunt`で実行できます。しかし、これにはCodesignとAuthenticodeの仮定が含まれるので、使っては行けないです。
それで、実行ファイルを作るスクリプトを用意しておきました。
```
grunt pre-build
```
実行ファイルは`dist`から見つかります。この場合、認証されていないため、自動アップデーターは使えません。
必要であれば、この実行ファイルからCodesignやAuthenticodeなどの署名ができます。

46
docs/ko/build.md Normal file
View File

@@ -0,0 +1,46 @@
# Build
## 개발
Webpack HRM을 개발을 위해 사용합니다.
다음 명령을 통해 저희가 해둔 설정을 사용 할 수 있습니다.
```
npm run webpack
```
몇 초 후, 다음 메세지를 보게 될겁니다.
```
webpack: bundle is now VALID.
```
그럼 앱을 실행합시다.
```
npm run hot
```
> 원래 앱은 `npm start`로 실행가능합니다. 하지만 이 경우, 컴파일된 스크립트를 사용할 것입니다.
이로써 웹팩이 자동적으로 코드변경을 확인하고 적용해줄 것입니다.
> ### 주의
> 가끔 직접 리프레쉬를 해주어야 하는 경우가 있습니다.
> 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우샐
> 2. 새로운 CSS코드를 추가할 경우(1.과 같은 이유: CSS클래스는 콤포넌트마다 다시 만들어 지는데, 이 작업은 컨스트럭터에서 일어납니다.)
## 배포
그런트를 사용합니다.
실제 디플로이는 `grunt`로 실행할 수 있습니다. 하지만, 여기엔 Codesign과 Authenticode의 과정이 포함되어있기 때문에 사용 하셔선 안됩니다.
그래서, 실행파일만을 만드는 스크립트를 준비해 뒀습니다.
```
grunt pre-build
```
실행 파일은 `dist`에서 찾을 수 있습니다. 이 경우, 인증이 되어있지 않기 때문에 업데이터는 사용할 수 없습니다.
필요로 하다면, 이 실행파일에 Codesign나 Authenticode등의 서명을 할 수 있습니다.

View File

@@ -2,6 +2,12 @@
オープンソースノートアプリ オープンソースノートアプリ
次の用務がある場合にはIssue trackerを利用してください。
- Boostnoteに関して質問したい時
- Boostnoteや計画事項にフィードバックがしたい時
- Boostnoteにバグを報告したい時
- Boostnoteに寄与したい時
## Goal ## Goal
単に何かを書くのが楽しくなってほしいです。 :grinning: 単に何かを書くのが楽しくなってほしいです。 :grinning:
@@ -34,6 +40,10 @@
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
## Development
- [Build](docs/build.md)
## Author & Maintainer ## Author & Maintainer
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r) [Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)

View File

@@ -2,6 +2,14 @@
오픈소스 노트 앱 오픈소스 노트 앱
다음과 같은 용무가 있는 경우 이슈트래커를 이용해 주세요.
- Boostnote에 대해 질문을 하고 싶을 때
- Boostnote나 계획사항에 대해 피드백을 주고 싶을 때
- Boostnote에 버그를 보고하고 싶을 때
- Boostnote에 기여하고 싶을 때
저흰 Slack을 운영하고 있습니다. 혹시 좀 더 저희들과 깊게 관여하고 싶으시다면 @rokt33r에 초대를 부탁하세요.
## Goal ## Goal
그냥 글쓰는게 즐거워지셨으면 좋겠어요. :grinning: 그냥 글쓰는게 즐거워지셨으면 좋겠어요. :grinning:
@@ -33,6 +41,10 @@
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
## Development
- [Build](docs/build.md)
## Author & Maintainer ## Author & Maintainer
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r) [Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)

View File

@@ -2,6 +2,14 @@
Simple opensource note app for developer. Simple opensource note app for developer.
You can use the issue tracker of this repository for
- asking a question about Boostnote
- giving a feedback about Boostnote and its future plan
- reporting a bug of Boostnote
- wanting to contribute Boostnote
We have a slack if you want to ingage us deeply, ask @rokt33r to join.
- [日本語](./readme-ja.md) - [日本語](./readme-ja.md)
- [한국어](./readme-ko.md) - [한국어](./readme-ko.md)
@@ -36,6 +44,10 @@ We just want you to enjoying writing anything. :grinning:
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
## Development
- [Build](docs/build.md)
## Author & Maintainer ## Author & Maintainer
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r) [Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)