Skip to content

Commit 7d4ae55

Browse files
committed
Docs: Update README.md
Rename Contributing.md to CONTRIBUTING.md
1 parent cff1cf1 commit 7d4ae55

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

โ€ŽContributing.mdโ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Handover์— ๊ธฐ์—ฌํ•˜๋Š” ๋ฒ•
2-
Handover ์˜ Contributing.md๋Š” ์˜คํ”ˆ์†Œ์Šค์ธ Ruby on Rails์˜ [Contributing.md](https://github.com/rails/rails/blob/main/CONTRIBUTING.md) ๋ฅผ ์ฐธ๊ณ ํ•˜์˜€์Šต๋‹ˆ๋‹ค
2+
Handover ์˜ Contributing.md๋Š” ์˜คํ”ˆ์†Œ์Šค์ธ Ruby on Rails์˜ [CONTRIBUTING.md](https://github.com/rails/rails/blob/main/CONTRIBUTING.md) ๋ฅผ ์ฐธ๊ณ ํ•˜์˜€์Šต๋‹ˆ๋‹ค
33

44
#### **๋ฒ„๊ทธ๋ฅผ ์ฐพ์œผ์…จ๋‚˜์š”?**
55

@@ -28,7 +28,7 @@ Handover ์˜ Contributing.md๋Š” ์˜คํ”ˆ์†Œ์Šค์ธ Ruby on Rails์˜ [Contributing.
2828

2929
#### **Handover ์˜ ๊ฐœ๋ฐœ๋ฌธ์„œ์— ๊ธฐ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹ ๊ฐ€์š”?**
3030

31-
* ํŒ€ Handover์— ์—ฐ๋ฝ์ฃผ์„ธ์š”! [Team Handover](https://github.com/osamhack2021/Web_Handover_Handover#-%ED%8C%80-%EC%A0%95%EB%B3%B4-team-info-)๐Ÿ”ฅ
31+
* ํŒ€ Handover ์—๊ฒŒ ์—ฐ๋ฝ์ฃผ์„ธ์š”! [Team Handover](https://github.com/osamhack2021/Web_Handover_Handover#-%ED%8C%80-%EC%A0%95%EB%B3%B4-team-info-) ๐Ÿ”ฅ
3232

3333

3434
๊ฐ์‚ฌํ•ฉ๋‹ˆ๋‹ค!

โ€ŽREADME.mdโ€Ž

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -135,16 +135,18 @@ Handover ๋‚ด์˜ ๋ชจ๋“  ๋ฌธ์„œ๋Š” **๐Ÿ—„๏ธ์„œ๋ž, ๐Ÿ“ฐ๋ฌธ์„œ, ๐Ÿ“‡์นด๋“œ** ์˜ 3
135135
<h2 id="install"> ๐Ÿš€ ์„ค์น˜ ์•ˆ๋‚ด (Installaltion Methods) </h2>
136136

137137
### 1. Docker ์„ค์ •
138-
์‚ฌ์šฉ ์šด์˜์ฒด์ œ์— ๋งž๋Š” Docker ์„ค์น˜ => [Get Docker](https://docs.docker.com/get-docker/)
138+
์‚ฌ์šฉํ•˜๋Š” ์šด์˜์ฒด์ œ์— ๋งž๋Š” [Docker ์„ค์น˜](https://docs.docker.com/get-docker/)
139139
### 2. Clone Repository
140140
```
141-
git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover
141+
git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover && cd handover
142142
```
143143

144144
### 3. Docker ์‹คํ–‰
145145
```
146146
npm run prd
147147
```
148+
### 4. ํ”„๋กœ์ ํŠธ ์‹คํ–‰ ํ™•์ธ
149+
[localhost](http://localhost) ์—์„œ ์„œ๋น„์Šค๋˜๊ณ  ์žˆ๋Š” Handover ํ™•์ธ
148150
### 4. Docker ์ค‘์ง€
149151
```
150152
npm down
@@ -162,12 +164,10 @@ Handover์— ๊ธฐ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹œ๋‹ค๋ฉด, **[Contributing.md](Contributing.md)**
162164

163165
<h2 id="structure"> ๐Ÿ•น๏ธ ์†Œ์Šค์ฝ”๋“œ ๊ตฌ์กฐ (Source Code Structure) </h2>
164166

165-
* Environment
166-
- `/`
167-
* WEB(FE)
168-
- `/frontend`
169-
* WEB(BE)
170-
- `/backend`
167+
### WEB(FE)
168+
`/frontend`
169+
### WEB(BE)
170+
`/backend`
171171

172172
<h2 id="teaminfo"> ๐Ÿ‘จโ€๐Ÿ‘ฆโ€๐Ÿ‘ฆ ํŒ€ ์ •๋ณด (Team Info) </h2>
173173

@@ -309,7 +309,7 @@ Handover์— ๊ธฐ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹œ๋‹ค๋ฉด, **[Contributing.md](Contributing.md)**
309309
</tbody>
310310
</table>
311311

312-
<h2 id="license"> ๐Ÿ“ ์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด (Copyleft / End User License) </h2>
312+
<h2 id="license"> ๐Ÿ“ ์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด (Copyright / End User License) </h2>
313313

314-
- [**MIT License**](https://opensource.org/licenses/MIT)
314+
- [**MIT License**](./LICENSE)
315315

0 commit comments

Comments
ย (0)