챕터 0 개발 환경 세팅 작성. 레이아웃 정리.

4roring · 4roring · commit d518f31c057f · 2023-03-25T23:26:35.000+09:00
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ ipython_config.py
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
+*/.idea/*
 .idea/**/workspace.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
diff --git a/README.md b/README.md
@@ -8,10 +8,12 @@ jupyter-book github page 접속 주소: https://pseudo-lab.github.io/CPython-Gui
    Pseudo-Lab/CPython-Guide
    ```
 
-2. 저장소를 받습니다.
+2. 저장소 및 python 패키지를 받습니다.
 
    ```bash
    git clone https://github.com/[작업자의 Github아이디]/CPython-Guide.git
+   cd [CPython-Guide 폴더]  # 윈도우즈 command line의 /d 옵션도 같이
+   pip install -r requirements.txt  # jupyter-book 패키지 설치, ghp-import는 꼭 설치안해도됨. (git action용)
    ```
 
 3. 담당 페이지 작업을 진행합니다.  
@@ -28,39 +30,29 @@ jupyter-book github page 접속 주소: https://pseudo-lab.github.io/CPython-Gui
    # TODO: pull request 하는 방법 첨부 예정.
    ```
 
-5. pull request 승인 후 push, merge가 완료되면 자동으로 빌드됩니다.
+5. pull request 승인 후 push가 완료되면 자동으로 사이트가 빌드됩니다.
 
 
 
 # jupyter-book 작업 구조
-```Diff
+```yaml
 CPython-Guide
-├── .github                # 
-├── book                   # 
-│   ├── _build   
-│   ├── docs
-│   ├── _config.yml
-│   ├── index.js
+├── .github                #  git action workflow가 있습니다.
+├── book                   #  문서 메인 폴더 입니다.
+│   ├── docs               #  문서가 모여있는 폴더입니다.
+│   ├── images             #  문서에 들어가는 이미지 폴더입니다.
+│   ├── _config.yml        #  github page config 입니다.
+│   ├── _toc.yml           #  문서 레이아웃 구성 파일 입니다.
+│   ├── intro.md           #  문서의 시작 페이지 파일 입니다.
 ├── README.md
 ├── requirements.txt
 └── .gitignore
 ```
-
-   ```
-   jupyter-book build 2021-Kaggle-Study/book
-   ```
-
-8. sync your local and remote repositories
-
-   ```
-   cd 2021-Kaggle-Study
-   git add .
-   git commit -m "adding my first book!"
-   git push
-   ```
-
-9. Publish your Jupyter Book with Github Pages
-
-   ```
-   ghp-import -n -p -f book/_build/html -m "initial publishing"
-   ```
+문서는 book/docs 폴더에 추가하고 작성합니다.
+_toc.yml에 문서를 등록해야 페이지에 보입니다.
+
+# 파일명 규칙
+1. docs: 챕터번호_섹션번호_문서제목  
+   (0_0_dev_env_setup.md, 0_1_directory_structure.md, 챕터 최상단은 0번 섹션으로 처리)
+2. images: 챕터폴더/사진순서(두자리)_사진내용  
+   (0_dev_env_setup/00_vscode_plugin.png, 0_dev_env_setup/01_tasks_explorer_result.png)
diff --git a/book/_toc.yml b/book/_toc.yml
@@ -3,11 +3,10 @@ root: intro
 parts:
 - caption: ◽ CPython 가이드
   chapters:
-  - file: docs/0_dev_env_setup
-  - file: docs/1_directory_structure
+  - file: docs/0_0_dev_env_setup
+    sections:
+      - file: docs/0_1_directory_structure
 
-
-- caption: ◽ 샘플
-  chapters:
-  - file: docs/sample/markdown-example
-  - file: docs/sample/notebook-example
+#- caption: ◽ 샘플
+#  - file: docs/sample/markdown-example
+#  - file: docs/sample/notebook-example
diff --git a/book/docs/0_0_dev_env_setup.md b/book/docs/0_0_dev_env_setup.md
@@ -39,7 +39,7 @@ git clone --branch 3.9 https://github.com/python/cpython.git
 ```
 .vscode/task.json 파일을 생성하고 위 내용을 작성합니다.  
 
-![VSCode 설치 플러그인](../images/0_dev_env_setup/01_tasks_explorer_result.png)  
+![태스크 세팅 결과](../images/0_dev_env_setup/01_tasks_explorer_result.png)  
 task.json 작성을 완료하면 TASK EXPLORER의 vscode 하위에 작성한 build task가 추가된 것을 볼 수 있습니다.
 
 ## launch.json 작성
@@ -51,7 +51,7 @@ task.json 작성을 완료하면 TASK EXPLORER의 vscode 하위에 작성한 bui
             "name": "msvc cl.exe debug cpython",
             "type": "cppvsdbg",
             "request": "launch",
-            "program": "./PCBuild/amd64/python_d.exe",
+            "program": "PCBuild/amd64/python_d.exe",
             "args": [],
             "stopAtEntry": false,
             "cwd": "${workspaceFolder}",
@@ -62,5 +62,12 @@ task.json 작성을 완료하면 TASK EXPLORER의 vscode 하위에 작성한 bui
     ]
 }
 ```
-.vscode/launch.json 파일을 생성하고 위 내용을 작성합니다.
+.vscode/launch.json 파일을 생성하고 위 내용을 작성합니다.  
+
+이제 F5를 누르면 CPython 빌드 진행 및 디버깅을 할 수 있습니다.  
+CPython의 진입점이 되는 Programs/python.c의 9번 라인에 디버그 브레이크를 걸고 실행해봅니다.
+![CPyhton 디버깅](../images/0_dev_env_setup/02_cpython_debugging.png)  
+위와 같이 디버깅 잡힌 것을 볼 수 있습니다.
+
+개발환경 세팅은 여기까지입니다.
 
diff --git a/book/docs/0_1_directory_structure.md b/book/docs/0_1_directory_structure.md
@@ -0,0 +1,20 @@
+# CPython 디렉터리 구조
+CPython 프로젝트의 디렉터리 구조입니다.
+```yaml
+CPython-Guide
+├── Doc             #  문서 소스 파일
+├── Grammar         #  컴퓨터가 읽을 수 있는 언어 정의
+├── Include         #  C 헤더 파일
+├── Lib             #  파이썬으로 작성된 표준 라이브러리 모듈
+├── Mac             #  macOS를 위한 파일
+├── Misc            #  기타 파일
+├── Modules         #  C로 작성된 표준 라이브러리 모듈
+├── Objects         #  코어 타입과 객체 모델
+├── Parser          #  파이썬 파서 소스 코드
+├── PC              #  이전 버전 윈도우를 위한 윈도우 빌드 지원 파일
+├── PCbuild         #  윈도우 빌드 지원 파일
+├── Python          #  CPython 인터프리터 소스 코드
+├── Tools           #  CPython을 빌드하거나 확장하는 데 유용한 독립 실행형 도구
+└── m4              #  makefile 구성을 자동화하는 사용자화 스크립트
+```
+
diff --git a/book/docs/1_directory_structure.md b/book/docs/1_directory_structure.md
diff --git a/book/images/0_dev_env_setup/02_cpython_debugging.png b/book/images/0_dev_env_setup/02_cpython_debugging.png
