Skip to content

Commit 510e4ff

Browse files
committed
Create README.md
1 parent eeac2e5 commit 510e4ff

File tree

2 files changed

+48
-1
lines changed

2 files changed

+48
-1
lines changed

.vscode/settings.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"terminal.integrated.defaultProfile.linux": "zsh",
33
"git.enableCommitSigning": true,
4-
"python.terminal.activateEnvironment": true
4+
"python.terminal.activateEnvironment": true,
5+
"markdownlint.config": {
6+
"no-inline-html": false,
7+
"single-title": false
8+
}
59
}

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Devcontainer로 개발환경 사용하기
2+
3+
- 필요한 모든 종속성이 포함된 개발 환경을 빠르게 설정
4+
- 일관되고 재현 가능한 개발 환경 공유
5+
- 로컬 환경과 격리된 컨테이너로 종속성 충돌 및 불필요한 설치 방지
6+
7+
<br/>
8+
9+
# 템플릿 리포지토리 사용방법
10+
11+
> 자세한 설명은 "[템플릿에서 리포지토리 만들기](https://docs.github.com/ko/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)" 링크를 참조하세요.
12+
13+
## Web에서 리포지토리 생성
14+
15+
오른쪽 위 `Use this template` 버튼을 눌러 새 리포지토리를 생성하세요.
16+
17+
## GitHub CLI로 내 GitHub 프로필에 새 리포지토리 생성
18+
19+
> `your-project-name`을 새로 생성할 리포지토리 이름으로 변경하세요.
20+
21+
```bash
22+
gh repo create --template https://github.com/AI-Data-System-EH/python-devcontainer-template --public your-repository-name
23+
```
24+
25+
## Git으로 로컬에 리포지토리 클론
26+
27+
> `your-repository-name`을 새로 생성할 리포지토리 이름으로 변경하세요.
28+
29+
```bash
30+
git clone https://github.com/AI-Data-System-EH/python-devcontainer-template your-repository-name
31+
```
32+
33+
<br/>
34+
35+
# Visual Studio Code에서 Devcontainer 프로젝트 열기
36+
37+
1. [Docker Desktop](https://www.docker.com/products/docker-desktop)(또는 [Docker CLI](https://docs.docker.com/engine/install/ubuntu/))를 설치합니다.
38+
2. [Visual Studio Code](https://code.visualstudio.com/)을 설치합니다.
39+
3. Visual Studio Code에 [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) 확장을 설치합니다.
40+
4. Visual Studio Code에서 `파일 > 폴더 열기...`를 선택하여 프로젝트를 엽니다.
41+
5. Visual Studio Code에서 `F1`을 눌러 `개발 컨테이너: 컨테이너에서 폴더 열기 (Dev Containers: Open Folder in Container)`를 선택합니다.
42+
> :warning: 프로젝트 폴더에 `.devcontainer/devcontainer.json` 파일이 있어야 vscode에서 devcontainer를 사용할 수 있습니다.
43+
6. 개발 컨테이너가 준비되면 프로젝트를 사용할 수 있습니다.

0 commit comments

Comments
 (0)