From f6f2332477ce16a96e0dd98a7c41a9ef03ed010d Mon Sep 17 00:00:00 2001
From: Kyungrim Park <79007826+g16rim@users.noreply.github.com>
Date: Wed, 4 Sep 2024 16:53:14 +0900
Subject: [PATCH] docs: README.md
---
README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 80 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48b8614
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# yourwriting-frontend
+'yourwriting' is note application that can generate your own font and use it on this application.
+
+### Service
+
+- 사용자의 글씨체를 바탕으로 폰트를 생성하고 이를 이용해 글을 작성할 수 있는 어플리케이션
+- 이 프로젝트의 제작 배경과 과정은 [youtubeLink](https://www.youtube.com/watch?v=snZSz7RWGZE&list=LL&index=5&t=24s)에서 확인할 수 있습니다.
+
+
+### Stacks
+
+
+
+### Cowork tools
+
+
+
+
+### 핵심 기능
+
+**로그인 기능**
+
+- 회원가입을 통해 사용자의 아이디 생성이 가능함.
+- 생성된 아이디를 통해 다른 기기에서도 자유롭게 글을 작성할 수 있음.
+
+**폰트 생성 기능**
+
+- 자음과 모음 40개를 차례로 직접 기기를 이용해 canvas에 그리고 이를 저장해 서버로 전송. (핸드폰, 아이패드 가능)
+- 폰트서버(flask)에 40개를 모아 한번에 전송. PNG파일로 전송하며 이 때 각 파일의 제목을 01~40으로 함.
+- 폰트서버에서 폰트를 생성 후 프론트로 전송. 프론트에서 받은 폰트를 getApplicationDocumentsDirectory()를 이용해 각 모바일 기기의 sandbox에 저장해 사용함.
+
+**노트 기능**
+
+- 노트목록은 노트서버(spring)에서 받아와 최신 날짜부터 차례로 정렬됨.
+- 플러스 버튼을 눌러서 노트 생성 가능.
+- 직접 만든 폰트로 작성되며 날짜와 제목도 함께 기록됨.
+- 생성된 버튼을 길게 누르면 GestureDetector의 onLongPress을 이용해 delete note 함수가 실행됨.
+- 글 작성시에는 글씨크기 조절, 이미지 추가 등도 가능함.
+
+
+
+
+### 기여
+
+**프로젝트 기획**
+
+- 프로젝트의 기획, figma를 이용한 디자인, 생성된 폰트를 더 정확하게 발전시키는 과정, 프론트의 모든 개발 과정에 적극적으로 참여함.
+- 팀장으로서 매주 발표, 영상 제작을 맡아서 진행함.
+- 'Development of User-Customized Korean Font Generation and Handwriting Application Using Python' 논문 작성에 적극적으로 참여하고 이에 대해 교수님과 소통하며 발전시킴.
+
+**기능 구현**
+
+- 앱 내 모든 화면을 구현하고 서버와의 연결, 앱의 빌드 등 프론트엔드에서 필요한 모든 기능을 구현함.
+- 폰트 생성 서버에서 폰트를 조합하고 생성하는 과정, 특히 겹받침 폰트를 생성하는 부분과 폰트 크기를 일괄적으로 맞추기 위해 사이즈 조절하는 기능을 구현함.
+- 폰트 노이즈를 줄이고 더 실제와 비슷한 폰트를 구현하기 위해 openCV와 python라이브러리를 결합하여 기능을 구현함.
+
+**테스트**
+
+- xcode를 이용해 휴대폰과 아이패드에 앱을 다운받고 이를 이용해 전시회 기간동안 다양한 폰트를 생성하고 이를 이용해 글을 작성함. 이후 구글폼QR을 준비해 사용자 평가도 진행함.
+
+
+
+### 앱 팜플렛 및 사용화면
+
+**팜플렛**
+
+
+
+
+
+
+**사용화면**
+
+
+ 
+
+
+ 
+ 
+