Skip to content

Commit a90d801

Browse files
baadaaRokt33r
andauthored
update korean docs in docs/ko/ (#3454)
* update korean docs in docs/ko/ * Fix typo Co-authored-by: Junyoung Choi <[email protected]>
1 parent 6369963 commit a90d801

File tree

2 files changed

+74
-4
lines changed

2 files changed

+74
-4
lines changed

docs/ko/build.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
* npm: 6.x
66
* node: 8.x
77

8-
`$ grunt pre-build``npm v5.x`에서 실행할 수 없기 때문에, 반드시 `npm v4.x`를 사용하셔야 합니다.
9-
108
## 개발
119

1210
개발에 있어서 Webpack HRM을 사용합니다.
@@ -29,6 +27,34 @@ $ yarn run dev
2927
> 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우
3028
> 2. 새로운 CSS코드를 추가할 경우(1.과 같은 이유: CSS클래스는 콤포넌트마다 다시 만들어 지는데, 이 작업은 컨스트럭터에서 일어납니다.)
3129
30+
## Pull Request에 사용된 코드를 적용하는 방법
31+
관련된 Pull request 페이지를 방문하여, url 스트링 마지막에 표기된 PR 번호를 확인합니다.
32+
<pre>
33+
https://github.com/BoostIO/Boostnote/pull/2794
34+
</pre>
35+
아래의 커맨드를 실행하면서, \<PR> 대신에 위에서 확인한 번호를 입력합니다 (부등호 신호는 빼고 입력하세요).
36+
위에 보여진 예시의 경우, \<PR> 자리에 2794를 입력하면 됩니다.
37+
38+
_본인의 로컬 컴퓨터에 마스터 브랜치가 복사되어 있지 않은 경우_
39+
```
40+
git clone https://github.com/BoostIO/Boostnote.git
41+
cd Boostnote
42+
git fetch origin pull/<PR>/head:<PR>
43+
git checkout <PR>
44+
```
45+
46+
_이미 마스터 브랜치를 로컬 컴퓨터에 저장해둔 경우_
47+
```
48+
git fetch origin pull/<PR>/head:<PR>
49+
git checkout <PR>
50+
```
51+
52+
_To compile and run the code_
53+
```
54+
yarn
55+
yarn run dev
56+
```
57+
3258
## 배포
3359

3460
Boostnote에서는 배포 자동화를 위하여 그런트를 사용합니다.
@@ -43,3 +69,31 @@ grunt pre-build
4369
실행 파일은 `dist`에서 찾을 수 있습니다. 이 경우, 인증이 되어있지 않기 때문에 업데이터는 사용할 수 없습니다.
4470

4571
필요로 하다면, 이 실행파일에 Codesign나 Authenticode등의 서명을 할 수 있습니다.
72+
73+
## 독자적인 배포판을 제작하는 방법 (deb, rpm)
74+
75+
배포판 패키지를 제작하려면 (우분투, 페도라 등) 리눅스 플랫폼에서 `grunt build` 커맨드를 실행하면 됩니다.
76+
77+
> 참조: 동일한 환경에서 `.deb` 파일과 `.rpm` 파일을 모두 만들 수 있습니다.
78+
79+
지원되는 버전의 `node``npm`을 설치한 다음, 빌드에 필요한 패키지를 설치합니다.
80+
81+
우분투/데비안 환경 (Ubuntu/Debian):
82+
83+
```
84+
$ sudo apt-get install -y rpm fakeroot
85+
```
86+
87+
페도라 환경 (Fedora):
88+
89+
```
90+
$ sudo dnf install -y dpkg dpkg-dev rpm-build fakeroot
91+
```
92+
93+
그 다음 `grunt build` 커맨드를 실행합니다.
94+
95+
```
96+
$ grunt build
97+
```
98+
99+
`dist` 디렉토리에 `.deb` 파일과 `.rpm` 파일이 새롭게 생성됩니다.

docs/ko/debug.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Boostnote의 디버그 방법(Electron app)
22

3+
## 구글 크롬 Developer Tools를 사용한 디버깅
4+
35
Boostnote는 Electron 애플리케이션이므로 Chromium위에서 작동합니다. 그렇기 때문에 개발자분들은 Google Chrome 브라우저에서 처럼 `Developer Tools`를 사용하실 수 있습니다.
46

57
다음과 같이 `Developer Tools`를 실행할 수 있습니다:
@@ -10,12 +12,26 @@ Boostnote는 Electron 애플리케이션이므로 Chromium위에서 작동합니
1012

1113
에러가 발생할 때에는, 에러메시지가 `console`위에 표시 됩니다.
1214

13-
## 디버깅
15+
### 디버깅
1416
예를들면 `debugger`를 사용하여 코드 안에서 다음과 같이 일시 정지지점을 설정할 수 있습니다:
1517

1618
![debugger](https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png)
1719

1820
이는 단순한 하나의 예시에 불과합니다. 자기자신에게 가장 잘 맞는 디버그 방법을 찾는 것도 좋을 것 입니다.
1921

20-
## 참고
22+
### 참고
2123
* [디버그에 관한 Google Chrome의 공식 문서](https://developer.chrome.com/devtools)
24+
25+
## 비주얼 스튜디오 코드를 사용한 디버깅
26+
27+
1. **[크롬 디버깅 플러그인](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome 'Install Debugger for Chrome')** 을 비주얼 스튜디오 코드에 설치한 후, 프로그램을 닫았다가 재실행합니다.
28+
2. **Shift+Command+B** 키를 누르거나, **Terminal** 메뉴 하단에 있는 **Run Build Task** 메뉴를 선택한 후 **Build Boostnote** 를 선택합니다. 아니면 터미널에서 곧바로 `yarn run watch`를 실행해도 됩니다.
29+
3. 위의 절차가 실행되고 있을 때, 사이드바 **Activity Bar**에서 **Debug view**를 선택합니다. 키보드 단축키로는 **Shift+Command+D**를 눌러도 됩니다..
30+
4. **Debug configuration**에서 **Boostnote All** 설정을 선택한 후, 초록색 화살표를 클릭하거나 **F5** 키를 누르면 디버깅이 시작됩니다.
31+
5. 이 시점에서는 **Boostnote**가 실행되고 있을 텐데, 두 개의 프로세스가 진행중인 것을 볼 수 있을 겁니다. 바로 **Boostnote Main** 프로세스와 **Boostnote Renderer** 프로세스입니다. 이제 비주얼 스튜디오 코드에서 곧바로 **디버깅 정지지점 (debug breakpoint)** 을 설정할 수 있습니다. 만약에 지정한 **정지지점 (breakpoint)** 이 등록되지 않는다면, **Boostnote Renderer****Boostnote Main** 프로세스 사이를 번갈아 확인해 보아야 합니다.
32+
33+
34+
### 참고
35+
36+
- [일렉트론 애플리케이션 디버깅 공식 튜토리얼](https://electronjs.org/docs/tutorial/application-debugging)
37+
- [비쥬얼 스튜디오 코드용 크롬 디버깅 플러그인](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)

0 commit comments

Comments
 (0)