diff --git a/README.md b/README.md index 2b25f7c..2f6f55f 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,4 @@ -# 🍴 Awesome Food Spots - -**Awesome Food Spots**λŠ” μ½”λ“œμž‡ μŠ€ν”„λ§ λ°±μ—”λ“œ μŠ€ν”„λ¦°ν„°κ°€ μ•Œκ³  μžˆλŠ” 맛집을 κ³΅μœ ν•˜λŠ” μ˜€ν”ˆ μ†ŒμŠ€ ν”„λ‘œμ νŠΈμž…λ‹ˆλ‹€. 각자의 μ§€μ—­μ—μ„œ μΆ”μ²œν•˜λŠ” λ§›μ§‘ 정보λ₯Ό μΆ”κ°€ν•˜κ³ , λ§›μ§‘ 지도λ₯Ό ν•¨κ»˜ λ§Œλ“€μ–΄ λ³΄μ„Έμš”! - - -## πŸš€ ν”„λ‘œμ νŠΈ μ†Œκ°œ - -이 ν”„λ‘œμ νŠΈλŠ” λ§›μ§‘ 정보λ₯Ό κ³΅μœ ν•˜λŠ” λ™μ‹œμ— GitHub의 Fork, Pull Request 과정을 ν•™μŠ΅ν•  수 μžˆλ„λ‘ μ„€κ³„λ˜μ—ˆμŠ΅λ‹ˆλ‹€. 재미있게 즐기며 κΈ°μ—¬ν•΄ λ³΄μ„Έμš”! - - - -## πŸ“š λ§›μ§‘ 정보 ν˜•μ‹ - -λ§›μ§‘ 정보λ₯Ό μΆ”κ°€ν•  λ•Œ μ•„λž˜μ˜ ν˜•μ‹μ„ λ”°λΌμ£Όμ„Έμš”. **Markdown** νŒŒμΌμ„ μ‚¬μš©ν•˜λ©°, `data/` 디렉토리에 μ €μž₯ν•©λ‹ˆλ‹€. - -### 파일 이름 κ·œμΉ™ -- μ§€μ—­λͺ…을 κΈ°μ€€μœΌλ‘œ μ €μž₯ν•©λ‹ˆλ‹€. 예: `data/μ„œμšΈ_광진ꡬ.md`, `data/λΆ€μ‚°_ν•΄μš΄λŒ€κ΅¬.md`. - -### λ§›μ§‘ 정보 μ˜ˆμ‹œ -```markdown ### [λ§›μ§‘ 이름] -- πŸ“ **μœ„μΉ˜:** μ„œμšΈμ‹œ 강남ꡬ ν…Œν—€λž€λ‘œ 123 -- 🍴 **메뉴 μΆ”μ²œ:** κΉ€μΉ˜μ°œ, 된μž₯찌개 -- ⭐ **평점:** 4.5/5 -- πŸ’¬ **μ½”λ©˜νŠΈ:** κΉ”λ”ν•˜κ³  λ§›μžˆλŠ” ν•œμ‹! μ μ‹¬μ‹œκ°„μ— κ°€λ©΄ 쀄 μ„œμ•Ό ν•  μˆ˜λ„ μžˆμ–΄μš”. -``` - -## πŸ› οΈ μ°Έμ—¬ 방법 - -μ•„λž˜ 단계λ₯Ό 따라 λ§›μ§‘ 정보λ₯Ό μΆ”κ°€ν•˜κ³  Pull Requestλ₯Ό λ³΄λ‚΄λ³΄μ„Έμš”! - -1. **ν”„λ‘œμ νŠΈ Fork:** - - 이 μ €μž₯μ†Œλ₯Ό μžμ‹ μ˜ κ³„μ •μœΌλ‘œ 포크(Fork)ν•˜μ„Έμš”. - -2. **μ €μž₯μ†Œ 클둠:** - - 둜컬 ν™˜κ²½μ— μ €μž₯μ†Œλ₯Ό ν΄λ‘ ν•©λ‹ˆλ‹€. - ```bash - git clone https://github.com/μ‚¬μš©μžλͺ…/awesome-food-spots.git - cd awesome-food-spots - ``` - -3. **λ§›μ§‘ 정보 μΆ”κ°€:** - - `data/` λ””λ ‰ν† λ¦¬μ—μ„œ ν•΄λ‹Ή μ§€μ—­ νŒŒμΌμ„ μ—΄κ³  λ§›μ§‘ 정보λ₯Ό μΆ”κ°€ν•˜μ„Έμš”. - - μ§€μ—­ 파일이 μ—†λ‹€λ©΄ μƒˆλ‘œ μƒμ„±ν•˜μ„Έμš”. - -4. **λ³€κ²½ 사항 컀밋:** - - μΆ”κ°€ν•œ λ‚΄μš©μ„ μ»€λ°‹ν•©λ‹ˆλ‹€. - ```bash - git add . - git commit -m "λ§›μ§‘ 정보 μΆ”κ°€ (μ§€μ—­λͺ…)" - ``` - -5. **μ €μž₯μ†Œλ‘œ ν‘Έμ‹œ:** - - λ³€κ²½ 사항을 μžμ‹ μ˜ 포크에 ν‘Έμ‹œν•©λ‹ˆλ‹€. - ```bash - git push origin main - ``` - -6. **Pull Request 보내기:** - - 원본 μ €μž₯μ†Œλ‘œ 이동해 Pull Requestλ₯Ό μƒμ„±ν•©λ‹ˆλ‹€. - - -## 🌟 κΈ°μ—¬ κ°€μ΄λ“œ - -- λˆ„κ΅¬λ‚˜ 자유둭게 κΈ°μ—¬ν•  수 μžˆμŠ΅λ‹ˆλ‹€. -- PR 제λͺ©μ— κ°„λ‹¨ν•œ μ„€λͺ…을 적어 μ£Όμ„Έμš”. 예: `λ§›μ§‘ 정보 μΆ”κ°€ (μ„œμšΈ)`. -- ν•˜λ‚˜μ˜ PRμ—λŠ” **ν•œ μ§€μ—­μ˜ λ§›μ§‘ 정보**만 μΆ”κ°€ν•΄μ£Όμ„Έμš”. - - -## πŸ’‘ κΈ°μ—¬μž λž­ν‚Ή - -맛집을 많이 μΆ”κ°€ν•΄ μ£Όμ‹  κΈ°μ—¬μžλŠ”μ—¬κΈ°μ„œ ν™•μΈν•˜μ„Έμš”! πŸ† - -- **1μœ„:** πŸ₯‡ -- **2μœ„:** πŸ₯ˆ -- **3μœ„:** πŸ₯‰ - - -## πŸŽ‰ 우리 ν”„λ‘œμ νŠΈμ— κΈ°μ—¬ν•˜λŠ” 첫 걸음! - -이 ν”„λ‘œμ νŠΈλŠ” μ΄ˆλ³΄μžμ™€ μ˜€ν”ˆ μ†ŒμŠ€ μž…λ¬Έμžλ₯Ό μœ„ν•œ κ³΅κ°„μž…λ‹ˆλ‹€. **Fork**, **Pull Request** 과정을 λ°°μš°λ©΄μ„œ λ§›μ§‘ 정보도 κ³΅μœ ν•˜κ³ , 즐겁게 ν˜‘μ—…μ„ κ²½ν—˜ν•΄ λ³΄μ„Έμš”. ❀️ - - -## πŸ“¬ 문의 - -- μ§ˆλ¬Έμ΄λ‚˜ 아이디어가 μžˆλ‹€λ©΄ [Issues](https://github.com/codeit-bootcamp-spring/awesome-food-spots/issues)λ₯Ό ν™œμš©ν•΄μ£Όμ„Έμš”! +- πŸ“ **μœ„μΉ˜:** κ²½κΈ° κ³ μ–‘μ‹œ 일산동ꡬ μΌμ‚°λ‘œ316번길 5-6 1μΈ΅ +- 🍴 **메뉴 μΆ”μ²œ:** μ˜€λ¦¬μ§€λ„λ§ˆμ œμ†Œλ°” +- ⭐ **평점:** 4.59/5