Skip to content

Commit 77148f1

Browse files
committed
Update README.md
1 parent 935602c commit 77148f1

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,30 @@
2222
![](https://i.imgur.com/x5Jnzs5.png)
2323

2424
## 설치
25+
### 빌드 결과
26+
|운영체제|결과|
27+
|---|:---:|
28+
|<img src="https://github.com/ngeenx/operating-system-logos/blob/master/src/128x128/WIN.png" width="16" alt="Windows logo"> Windows 11|✅ 성공|
29+
|<img src="https://github.com/ngeenx/operating-system-logos/blob/master/src/128x128/UBT.png" width="16" alt="Ubuntu logo"> Ubuntu 24.04|✅ 성공|
30+
|<img src="https://github.com/ngeenx/operating-system-logos/blob/master/src/128x128/MAC.png" width="16" alt="macOS logo"> macOS Sequoia|✅ 성공|
31+
2532
### 공통
2633
1. 이 레포지토리를 다운로드합니다.
27-
1. [Node.js][node.js]설치합니다.
34+
1. [Node.js][node.js][npm][npm]설치합니다.
2835
- 호환되는 버전은 **20.x** 또는 **22.x**입니다.
2936
- 이외의 버전 설치 시 TensorFlow의 의존성 문제로 제대로 동작하지 않습니다.
3037
- 다른 Node.js 버전을 사용 중일 경우 [.nvmrc](.nvmrc) 파일을 참고해 권장 버전을 사용할 수 있습니다.
31-
[nvm](https://github.com/nvm-sh/nvm)을 설치하고 다음 명령어로 권장 버전을 사용합니다.
32-
38+
[nvm](https://github.com/nvm-sh/nvm)을 설치하고 다음 명령어로 권장 버전을 사용합니다.
3339
```bash
3440
nvm install 22
3541
nvm use 22
3642
node -v
3743
```
38-
1. [.env.example](.env.example)`.env`로 변경합니다.
39-
1. [targets.example.json](targets.example.json)`targets.json`으로 변경합니다.
44+
1. `npm install`을 입력하여 의존성을 설치합니다.
4045

4146
### 로컬
4247
1. [Python][python] **3.x** 버전을 설치합니다.
43-
2. 빌드 도구를 설치합니다.
48+
2. TensorFlow 빌드 도구를 설치합니다.
4449
#### Windows
4550
[Microsoft C++ Build Tools](https://visualstudio.microsoft.com/ko/visual-cpp-build-tools)를 설치합니다. ([링크](https://rinkesh-patel.medium.com/easy-way-to-install-tensorflow-tfjs-node-in-windows-11-machine-158f049d9efa) 참고)
4651

@@ -49,7 +54,7 @@
4954

5055
#### macOS
5156
`xcode-select --install`
52-
1. `npm install`을 입력하여 의존성을 설치합니다.
57+
1. [.env.example](.env.example)`.env`로, [targets.example.json](targets.example.json)`targets.json`으로 변경합니다.
5358
1. `npm start` 또는 `npm run pm2:start`를 입력하여 프로그램을 실행합니다.
5459

5560
### 도커
@@ -61,17 +66,11 @@
6166
![](https://i.imgur.com/R7QZi2d.png)
6267

6368
1. 아래 두 가지 방법 중 하나를 선택하세요.
64-
- Docker Hub에 올려둔 빌드된 이미지를 내려받아 컨테이너를 실행합니다.
65-
이 경우 [공통](#공통)의 파일 이름을 바꾸는 과정은 필요없습니다.
66-
#### Windows
67-
`npm run docker:up`
68-
#### Linux / macOS
69-
`make up` 또는 `npm run docker:up`
70-
- 로컬 소스 코드를 기반으로 이미지를 빌드하고 실행합니다.
71-
#### Windows
72-
`npm run docker:build`
73-
#### Linux / macOS
74-
`make build` 또는 `npm run docker:build`
69+
- **(권장) Docker Hub에서 이미지를 내려받아 컨테이너를 실행합니다.**
70+
1. `npm run docker:up`
71+
- 로컬에서 이미지를 빌드하고 실행합니다.
72+
1. [.env.example](.env.example)`.env`로, [targets.example.json](targets.example.json)`targets.json`으로 변경합니다.
73+
1. `npm run docker:build`
7574

7675
## 사용법
7776
- 기본적으로 이미지는 레포지토리 하위의 archive 폴더 내에 저장됩니다.
@@ -102,6 +101,7 @@ Authored and maintained by xCrypt0r
102101

103102
[typescript]: https://www.typescriptlang.org
104103
[node.js]: https://nodejs.org/ko
104+
[npm]: https://www.npmjs.com
105105
[python]: https://www.python.org/downloads
106106
[docker]: https://docs.docker.com/get-started/get-docker
107107
[my github]: https://github.com/xCrypt0r

0 commit comments

Comments
 (0)