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

Create README #2

Open
jopopcorn opened this issue Aug 15, 2021 · 12 comments
Open

Create README #2

jopopcorn opened this issue Aug 15, 2021 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jopopcorn
Copy link
Member

Create README

  • Draw up README explaining how to introduce and use the demo app.
@jopopcorn jopopcorn added the documentation Improvements or additions to documentation label Aug 15, 2021
@aiclaudev
Copy link
Contributor

aiclaudev commented Aug 15, 2021

I think the configuration below would be appropriate.

Soundless-check-in

euphony_logo

This is a check-in application that identifies visitors, especially effective during the COVID-19.

Reason for making this application

The existing 'QR code check-in' has the following problems.

  • If the lens of the device receiving the data is dirty, it is not recognized well.
  • If the surroundings are too bright or too dark, it is not recognized well.
  • The process of accessing QR codes is complicated, especially for the elderly.

But, This application has no such inconvenience as using sound wave communication.

Run the app

Images or video ...

Report Issues

To report a specific problem or feature request, please open a new issue.

Library

It is based on Euphony library.
Official Facebook Page : https://www.facebook.com/euphonyproject
Official Library Site : https://dev.jbear.co/euphony

Please comment if there is anything that needs to be added or modified!

@JuSeongPil
Copy link
Contributor

I make some change the config for the customer's view

Soundless-check-in


euphony_logo

Euphony Speaker demo app generates noiseless sound wave to send the data.
When transferring data, the 'Speaker' generates an inaudible frequency and the 'Listener' receives it.

This is a check-in application that replace the QR code.
The QR code is hard for adults to using their mobile.
And this soundless check-in application can identifies the visitors following 3 information
-1. There Phone number
-2. There Residential Area
-3.The store that they visit

Follow the steps below and experience sound communication !

Reason for making this application


The existing 'QR code check-in' has the following problems.

  • If the lens of the device receiving the data is dirty, it is not recognized well.

  • If the surroundings are too bright or too dark, it is not recognized well.

  • The process of accessing QR codes is complicated, especially for the elderly.

But, This application has no such inconvenience as using sound wave communication.

Run the app

Images or video ...

Report Issues

To report a specific problem or feature request, please open a new issue.

Library

It is based on Euphony library.

Official Facebook Page : https://www.facebook.com/euphonyproject

Official Library Site : https://dev.jbear.co/euphony

Please comment free:)

@sujin9
Copy link
Member

sujin9 commented Aug 18, 2021

I have a few ideas!

First,

Euphony Speaker demo app generates noiseless sound wave to send the data.
When transferring data, the 'Speaker' generates an inaudible frequency and the 'Listener' receives it.

I think it's better to delete these two sentences because it's related to speaker demo app than our service.
Instead, we can indicate that we use euphony library for this app.

Second,
How about add 'What's next' category?
We can write something can be updated in this section later !
지금은 샘플앱이지만 euphony 라이브러리가 업데이트 됨에 따라 추가하면 좋겠다 하는 기능
혹은 앞으로 이렇게 발전되면 좋겠다 하는 부분을 추가하면 어떨까요?

Please let me know your opinion on this :)

@jopopcorn
Copy link
Member Author

First,

Euphony Speaker demo app generates noiseless sound wave to send the data.
When transferring data, the 'Speaker' generates an inaudible frequency and the 'Listener' receives it.

I think it's better to delete these two sentences because it's related to speaker demo app than our service.
Instead, we can indicate that we use euphony library for this app.

I agree with both of Sujin's opinions! I think deleting this sentence would go well with the context.

Second,
How about add 'What's next' category?
We can write something can be updated in this section later !
지금은 샘플앱이지만 euphony 라이브러리가 업데이트 됨에 따라 추가하면 좋겠다 하는 기능
혹은 앞으로 이렇게 발전되면 좋겠다 하는 부분을 추가하면 어떨까요?

And I think it's a good idea to write down the features and improvements we need to consider development expansion.

@aiclaudev
Copy link
Contributor

aiclaudev commented Aug 27, 2021

Soundless-check-in

euphony_logo

This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database

Visitor's phone number
Visitor's residential area
Information of company that they visit

Reason for making this application

The existing 'QR code check-in' has the following problems.

  • If the lens of the device receiving the data is dirty, it is not recognized well.
  • If the surroundings are too bright or too dark, it is not recognized well.
  • The process of accessing QR codes is complicated, especially for the elderly.

But, This application has no such inconvenience as using sound wave communication.

Run the app

  • Visitor

  1. Press setting icon
  2. Enter your phone number, and residential area
  3. Check your information, and press 'CHECK IN'
  • Company

  1. Press setting icon
  2. Enter the company information.

Report Issues

To report a specific problem or feature request, please open a new issue.
Your participation drives the development of the application!

Library

It is based on Euphony library.
Official Facebook Page : https://www.facebook.com/euphonyproject
Official Library Site : https://dev.jbear.co/euphony

@aiclaudev
Copy link
Contributor

Add images in 'Run the app' and change a few things reflecting above feedback.
I wanted to add 'What's next' category, but i don't know what to write in this category.
So I didn't add it for now. If there anything wrong, Please comment !

This was referenced Aug 28, 2021
@designe
Copy link
Member

designe commented Sep 1, 2021

Could you check one more review in README.md

for example,

But, This application has no such inconvenience as using sound wave communication.
If you press the 'GET INFO !', you can receive visitors' information.

@aiclaudev
Copy link
Contributor

Could you check one more review in README.md

for example,

But, This application has no such inconvenience as using sound wave communication.
If you press the 'GET INFO !', you can receive visitors' information.

I changed sentence you mentioned.

Because this application is user-friendly and use sound-communication, there is no inconvenience like above !
If you press the 'GET INFO!', this application will be state that can recognize visitor's information.

Is it okay? Really appreciate for your feedback !!

@designe
Copy link
Member

designe commented Sep 1, 2021

@aiclaudev
Thanks for the quick fix and reflection.
I once again asked for a review from the team members, because a review can make a better project!
You have done well so far and I think you will do even better in the future :)

@jopopcorn
Copy link
Member Author

@designe Thank you for ur detailed feedback!
Lastly, I'll review it and leave the comment if there is anything to modify.

@jopopcorn
Copy link
Member Author

jopopcorn commented Sep 2, 2021

Soundless-check-in

euphony_logo

This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database

Visitor's phone number
Visitor's residential area
Information of company that they visit

@aiclaudev

It was difficult to review quickly yesterday, so I'm commenting late.
I think this it would be good to change this phrase as follows.
I think the rest was well reflected based on the mentor's feedback!
Thank you for your effort!


Soundless-check-in

This is a check-in application that identifies visitors, especially effective during the COVID-19.
You can check in with sound wave communication instead of QR code.
When the check-in is complete, visitor and store information are stored in the database, along with the check-in time.

@aiclaudev
Copy link
Contributor

Soundless-check-in

euphony_logo
This is a check-in application that identifies visitors, especially effective during the COVID-19.
This application stores below informations in database

Visitor's phone number
Visitor's residential area
Information of company that they visit

@aiclaudev

It was difficult to review quickly yesterday, so I'm commenting late.
I think this it would be good to change this phrase as follows.
I think the rest was well reflected based on the mentor's feedback!
Thank you for your effort!

Soundless-check-in

This is a check-in application that identifies visitors, especially effective during the COVID-19.
You can check in with sound wave communication instead of QR code.
When the check-in is complete, visitor and store information are stored in the database, along with the check-in time.

Thanks ! If the existing sentence is changed by your suggestion, README.md readers will be able to understand the app more easily. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants