Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md 파일 생성 #32

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
![Thumbnail](https://github.com/user-attachments/assets/f5576d16-1872-44f3-be6f-d3396e167bac)

![Platform](https://img.shields.io/badge/Platform-Android-orange.svg)
![API](https://img.shields.io/badge/API-23%2B-green.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<!-- [![JitPack](https://jitpack.io/v/yourssu/YDS-Android.svg)](https://jitpack.io/#yourssu/YDS-Android) -->

## 🎨 Handy란
Handy는 숭실대학교 동아리 유어슈에서 사용하는 디자인 시스템입니다. [ ~~TODO Handy 목적 ]위해 고안됐습니다.

## 📝 문서
[Handy Docs](https://www.figma.com/design/eG7K8ZRFJrJtPeFaK8k5Vn/Handy---Yourssu-Design-System?node-id=223-4135&p=f&t=tpfBSCnp3NCZtZQb-0)
Figma에서 컴포넌트 정보와 사용 예시 등 Handy 문서를 확인하실 수 있습니다.

<!--
## 🛠 설치 방법
#### gradle Project
```kts
allprojects {
repositories {
'...'
maven { url = uri("https://jitpack.io") }
}
}
```
#### gradle app
```kts
// YDS for both XML and Compose
implementation("com.github.yourssu:YDS-Android:${YDSVersion}")

// YDS for XML view
implementation("com.github.yourssu.YDS-Android:DesignSystem:${YDSVersion}")

// YDS for Jetpack Compose
implementation("com.github.yourssu.YDS-Android:compose:${YDSVersion}")
```
#### theme
- 라이트 테마
```xml
<application
android:theme="@style/Theme.Light.YourssuDesignSystem"
...
```
- 라이트/다크 테마
```xml
<application
android:theme="@style/Theme.DayNight.YourssuDesignSystem"
...
```

## 🧪 샘플 어플리케이션
<img src="https://user-images.githubusercontent.com/39309953/141673413-0e76bb0b-3d52-4f06-af15-5a070e20ebad.gif" width=300 />
<a href='https://play.google.com/store/apps/details?id=com.yourssu.storybook&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='다운로드하기 Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/ko_badge_web_generic.png' width=200 /></a>

## 🖥 YDS 개발자 규칙
[YDS 개발 수칙](https://www.notion.so/yourssu/Android-309726587b1943a4bfb3f501e3ed672a)

-->
## 💻 타 버전 저장소
[YDS-iOS](https://github.com/yourssu/Handy-iOS)
[YDS-React](https://github.com/yourssu/Handy-React)