From c9e8c3143b1a54bc93c2c1ceaf1bada31734f732 Mon Sep 17 00:00:00 2001
From: Dowoo Kim <109224863+KDW03@users.noreply.github.com>
Date: Tue, 31 Oct 2023 16:43:47 +0900
Subject: [PATCH] Update README.md
---
README.md | 36 ++++++++++++++++++++++++++++++++++++
1 file changed, 36 insertions(+)
diff --git a/README.md b/README.md
index ce2b604b..99b3284f 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,9 @@
![image](https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/91100610-2cfa-434c-9cb9-c5ecaf106e13)
+
+
+
## ๐ธ ํ๋ก์ ํธ ์๊ฐ
์์คํ ์ฐ์ธ๊ณผ์ ์ถ์ต์ ๊ธฐ๋กํด ๋ณด์ธ์ ๐ฅฐ
@@ -11,6 +14,10 @@
์์น์ ๋ ์ง๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ์ถ์ต์ ๋ชจ์๋ณผ ์ ์์ด์ โบ
+
+
+
+
## ๐ฉโ๐ป ๊ฐ๋ฐ์
@@ -21,6 +28,11 @@
+
+
+
+
+
## ๐ ๏ธ ์ํคํ
์ฒ
@@ -30,6 +42,9 @@
์ ์ฒด ๊ตฌ์กฐ๋ UI Layer๊ณผ Data Layer, ๋ ๋ถ๋ถ์ผ๋ก ์ด๋ฃจ์ด์ ธ ์์ต๋๋ค. ๊ฐ ๊ณ์ธต์ ์์ ๋ง์ ์์๋ค์ ๊ฐ์ง๊ณ ํน์ ์ญํ ์ ํฉ๋๋ค. ํ์ดํ๋ ํ ์์๊ฐ ๋ค๋ฅธ ์์์ ์์กดํ๋ค๋ ๊ฒ์ ๋ํ๋
๋๋ค.
+
+
+
### **๐ ์ํคํ
์ฒ ๊ฐ์**
@@ -44,6 +59,8 @@
+
+
## ๐ชง ๋ชจ๋ํ
@@ -57,6 +74,11 @@
- **feature:Module** - ํน์ ๊ธฐ๋ฅ์ ๋ด๋นํ๋ ๋ชจ๋์
๋๋ค. ํ์ํ ๋ ๋ค์ํ ์ฑ์์ ์ฌ์ฌ์ฉ ๊ฐ๋ฅํ๋ฉฐ, ๋
๋ฆฝ์ ์ผ๋ก ์ ์ง๋ฉ๋๋ค. ํ ํด๋์ค๊ฐ ํน์ `feature` ๋ชจ๋์๋ง ํ์ํ๋ฉด ๊ทธ ์์ ๋ฌ์ผ ํฉ๋๋ค. ๊ทธ๋ ์ง ์์ผ๋ฉด `core` ๋ชจ๋๋ก ์ฎ๊ฒจ์ผ ํฉ๋๋ค. `feature` ๋ชจ๋์ ๋ค๋ฅธ `feature` ๋ชจ๋์ ์์กดํ๋ฉด ์ ๋๋ฉฐ, `core` ๋ชจ๋์๋ง ์์กดํด์ผ ํฉ๋๋ค.
- **core:Module** - ์ฑ ๋ด์์ ๊ณตํต์ ์ผ๋ก ์ฌ์ฉ๋๋ ๋ถ๋ถ๋ค์ ๋ด์ ๋ผ์ด๋ธ๋ฌ๋ฆฌ ๋ชจ๋์
๋๋ค. ๋ค๋ฅธ `core` ๋ชจ๋์๋ ์์กดํ ์ ์์ง๋ง, `feature`์ด๋ `app` ๋ชจ๋์๋ ์์กดํ๋ฉด ์ ๋ฉ๋๋ค.
+
+
+
+
+
## ๐งช Testing
**Mineme**๋ `Hilt`๋ฅผ ์ฌ์ฉํ DI๋ก testing์ ์ฝ๊ฒ ํฉ๋๋ค.
@@ -69,6 +91,12 @@
- Instrumentation tests์์, ์ฌ์ฉ์์ preferences๋ฅผ ์์ ํด๋์ ์ ์ฅํ ํ, ํ
์คํธ๊ฐ ๋๋๋ฉด ์ญ์ ํฉ๋๋ค. ์ด๋ ๊ฒ ํจ์ผ๋ก์จ real DataStore์ ๋์์ ๋ชจ๋ ํ
์คํธํ ์ ์์ต๋๋ค.
- Test versions์ repositories๋ standard repositories์ ๊ฐ์ ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ฉฐ, ์ถ๊ฐ์ ์ธ testing hooks๋ ์ ๊ณตํฉ๋๋ค. ์ด๋ฅผ ํตํด ViewModel์ behavior๋ฅผ ๊ฒ์ฆํฉ๋๋ค.
+
+
+
+
+
+
## ๐ฅ๏ธ UI
**Mineme**๋ [Material 3 ๊ฐ์ด๋๋ผ์ธ](https://m3.material.io/)์ ์ฌ์ฉํ์ฌ ๋์์ธ๋์์ต๋๋ค.
@@ -78,6 +106,10 @@
- **๋์ ์์** - ์ฌ์ฉ์์ ํ์ฌ ์์ ํ
๋ง๋ฅผ ๊ธฐ๋ฐ
- **๊ธฐ๋ณธ ํ
๋ง** - ๋์ ์์์ ์ง์ํ์ง ์์ ๋
+
+
+
+
## ยฉ๏ธ License
```
@@ -96,4 +128,8 @@
limitations under the License.
```
+
+
+
+
## ๐ ๊ฐ๋ฐ๋ก๊ทธ