search

euphony-io / sound-helper

Euphony Demo for patients and assistants in case of an emergency.
Apache License 2.0
5 stars 4 forks source link

README.md composition #2

Open judemin opened 3 years ago

judemin commented 3 years ago

앱 사용법과 각 페이지의 목적등을 간결하게 정리 영어, 한국어 모두 작성 샘플 애플리케이션 개발 후 작성

kuro11pow2 commented 3 years ago

chrome_ebpQdqropn chrome_MwPGcI4955

How about writing two documents in English and Korean like the attached image?

judemin commented 3 years ago

I agree. Like early reviews of mentors in euphony-listener we could write two readme files. (README.md, README.kr.md)

kuro11pow2 commented 3 years ago

All right, let's talk about the composition of README.md. I think it would be good to put "the objectives of app" and "how to achieve objectives" in the "Introduction" section.

kmsaidev commented 3 years ago

Also, I think it would be good to write quick-start through pictures like euphony-listener. To make it easier for people who are new to use it!

kuro11pow2 commented 3 years ago

Also, I think it would be good to write quick-start through pictures like euphony-listener. To make it easier for people who are new to use it!

I agree with your opinion!

judemin commented 3 years ago

How about using this template for our README? https://github.com/always0ne/repositoryTemplate

eunzinn commented 3 years ago

How about using this template for our README? https://github.com/always0ne/repositoryTemplate

Good! Using an index is a good idea.

kuro11pow2 commented 3 years ago

How about using this template for our README? https://github.com/always0ne/repositoryTemplate

The template looks good! I agree to use this template.

judemin commented 3 years ago

Just created README.md only with template. Maybe we should divide roles as we did in euphony-listener.

eunzinn commented 3 years ago

Just created README.md only with template. Maybe we should divide roles as we did in euphony-listener.

Do we have to make the configuration(overview, getting stated, contributing ...) as it is in the template?

judemin commented 3 years ago

Yes, I think we should add some androidTestImplementation, modules for readers.