diff --git a/README.md b/README.md index 060bac16..332bc1cc 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,12 @@ -# Main - -### 사용법 - -| Tag name | Description | -|:-------------------|:------------| -|**Feat** |새로운 기능을 추가| -|**Fix** |버그 수정| -|**Design** |CSS 등 사용자 UI 디자인 변경| -|**!BREAKING CHANGE**|커다란 API 변경의 경우| -|**!HOTFIX** |급하게 치명적인 버그를 고쳐야하는 경우| -|**Style** |코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우| -|**Refactor** |프로덕션 코드 리팩토링| -|**Comment** |필요한 주석 추가 및 변경| -|**Docs** |문서 수정| -|**Test** |테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음| -|**Chore** |빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음| -|**Rename** |파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우| -|**Remove** |파일을 삭제하는 작업만 수행한 경우| - -1. 레포 클론 - - ```bash - git clone https://github.com/42Seoul-LastDance/Main.git && cd Main - ``` - -2. **[클러스터]** 도커가 꺼져있다면 `make docker` 로 도커 실행 - -3. 도커 실행 후 `make`하여 ts 컴파일 컨테이너 실행 -4. srcs 폴더에서 작업 (볼륨 연결 되어있음) -5. `make compile` -> `srcs` 폴더 하위에 있는 모든 `.ts` 파일 컴파일 -> `.js`로 바뀜 -6. 웹 브라우저에서 `index.html` 열기 - - vscode extension -> Live Preview -> Show Preview (External Browser) 로 바로 실행 가능 +# Web Service + +> Real-time Multiplayer Pong Game with Chat, OAuth + +

+ +Screen Shot 2023-11-03 at 6 29 10 PM + +

### 깃 브랜치 Git Flow에서는 총 5개의 브랜치를 사용합니다. 각 브랜치에 대해 간단하게 알아보도록 하겠습니다.