김태영

Update README.md

1 -# Mask-Wearing Discriminator
2 -## Outline
3 -Mask-Wearing Discriminate Program Using Teachable Machine 2.0 <br>
4 -Using teachable machine 2.0 provided by Google, a model was created that learned the type of mask wearing.<br>
5 -This program recognizes a person's face input through a webcam in real time and determines whether to wear a mask. <br>
6 -## Member
7 -컴퓨터공학과 2017103978 김태영 <br>
8 -컴퓨터공학과 2017104015 이재호 <br>
...\ No newline at end of file ...\ No newline at end of file
1 +<!--
2 +*** Thanks for checking out the Best-README-Template. If you have a suggestion
3 +*** that would make this better, please fork the repo and create a pull request
4 +*** or simply open an issue with the tag "enhancement".
5 +*** Thanks again! Now go create something AMAZING! :D
6 +-->
7 +
8 +
9 +
10 +<!-- PROJECT SHIELDS -->
11 +<!--
12 +*** I'm using markdown "reference style" links for readability.
13 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
14 +*** See the bottom of this document for the declaration of the reference variables
15 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
16 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
17 +-->
18 +<!--
19 +[![Contributors][contributors-shield]][contributors-url]
20 +[![Stargazers][stars-shield]][stars-url]
21 +[![Issues][issues-shield]][issues-url]
22 +[![MIT License][license-shield]][license-url]
23 +[![LinkedIn][linkedin-shield]][linkedin-url]-->
24 +
25 +
26 +
27 +<!-- PROJECT LOGO -->
28 +<br />
29 +<p align="center">
30 + <a href="https://github.com/othneildrew/Best-README-Template">
31 + <img src="readme_img/logo.png" alt="Logo" width="80" height="80">
32 + </a>
33 +
34 + <h3 align="center">MWD Readme!!</h3>
35 +
36 + <p align="center">
37 + 구글 Teachable Machine 2.0을 이용하여 마스크 착용 검사 및 출입부 작성 기능을 제공합니다.
38 + <br />
39 + <!--여기 뭐 넣을지 생각해보자-->
40 + <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject"><strong>Explore the docs »</strong></a>
41 + <br />
42 + <br />
43 + <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject">View Demo</a>
44 + ·
45 + <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues">Report Bug</a>
46 + ·
47 + <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues">Request Feature</a>
48 + </p>
49 +</p>
50 +
51 +
52 +
53 +<!-- TABLE OF CONTENTS -->
54 +<details open="open">
55 + <summary>Table of Contents</summary>
56 + <ol>
57 + <li>
58 + <a href="#about-the-project">About The Project</a>
59 + <ul>
60 + <li><a href="#built-with">Built With</a></li>
61 + </ul>
62 + </li>
63 + <li>
64 + <a href="#getting-started">Getting Started</a>
65 + <ul>
66 + <li><a href="#prerequisites">Prerequisites</a></li>
67 + <li><a href="#installation">Installation</a></li>
68 + </ul>
69 + </li>
70 + <li><a href="#usage">Usage</a></li>
71 + <li><a href="#roadmap">Roadmap</a></li>
72 + <li><a href="#contributing">Contributing</a></li>
73 + <li><a href="#license">License</a></li>
74 + <li><a href="#contact">Contact</a></li>
75 + <li><a href="#acknowledgements">Acknowledgements</a></li>
76 + </ol>
77 +</details>
78 +
79 +
80 +
81 +<!-- ABOUT THE PROJECT -->
82 +## About The Project
83 +
84 +구글 Teachable Machine 2.0을 이용하여 마스크 착용 검사 및 출입부 작성 기능을 제공합니다.
85 +
86 +
87 +### Built With
88 +
89 +* [Bootstrap](https://getbootstrap.com)
90 +* [JQuery](https://jquery.com)
91 +* [Nodejs](https://nodejs.org)
92 + - [express](https://github.com/expressjs/express)
93 + - [ejs](https://github.com/mde/ejs)
94 +* [Teachable Machine](https://teachablemachine.withgoogle.com)
95 +
96 +
97 +
98 +
99 +<!-- GETTING STARTED -->
100 +## Getting Started
101 +
102 +1. main page 접속<br>
103 + 1.1 <urL>을 통해 접속합니다.<br><br>
104 +2. 카메라 허용<br>
105 + 2.1 카메라 허용 메시지가 표시되면 허용을 선택합니다.<br><br>
106 +
107 +### Installation
108 +
109 +1. Clone the repo
110 + ```sh
111 + git clone http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject.git
112 + ```
113 +2. Install NPM packages
114 + ```sh
115 + npm install
116 + ```
117 +3. Enter your API in `index.ejs`
118 + ```JS
119 + const URL = 'ENTER YOUR Teachable Machine Model Url';
120 + ```
121 +4. Start Server in npm located.
122 + ```sh
123 + npm start
124 + ```
125 +
126 +
127 +<!-- USAGE EXAMPLES -->
128 +## Usage
129 +
130 +[![Product Name Screen Shot][product-screenshot1]]()<br><br>
131 +[![Product Name Screen Shot][product-screenshot2]]()<br><br>
132 +[![Product Name Screen Shot][product-screenshot3]]()<br><br>
133 +1. 마스크 착용 판별 기능<br>
134 + 1.1. 카메라 정면을 바라보고 서있는다. <br>
135 + 1.2. 마스크 착용 여부에 따라 캠 우측의 이미지가 변하고 소리가 출력된다.<br>
136 +<br>
137 +2. 출입내역 기록 기능<br>
138 + 2.1. 처음 페이지에 접속하여 출입내역을 작성할 곳의 위치를 입력한다.<br>
139 + 2.2. 건물에 출입하는 인원들은 캠 앞에서서 이름, 전화번호, 신분을 선택하고 제출을 누른다.<br/>
140 + 2.3. 이때 마스크를 착용하지 않았다면 작성한 내용을 제출이 불가능하다.<br><br>
141 +3. 출입내역 저장 기능<br>
142 + 3.1 지금까지 기록한 내용들을 '저장' 버튼을 눌러 파일을 생성한다.<br>
143 + 3.2 생성한 파일을 '다운로드'를 통해 로컬에 저장한다.<br><br>
144 +
145 +더 많은 정보를 원하신다면, [Teachablemachine Documentation](https://teachablemachine.withgoogle.com) 를 참고해주세요.
146 +
147 +
148 +
149 +<!-- ROADMAP -->
150 +## Roadmap
151 +
152 +See the [open issues](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues) for a list of proposed features (and known issues).
153 +
154 +
155 +
156 +<!-- CONTRIBUTING -->
157 +## Contributing
158 +
159 +해당 프로젝트에 기여하고 싶다면 아래의 절차를 따라주세요. <br>
160 +**어떠한 기여도 환영입니다!!**.<br>
161 +1. Fork the Project
162 +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
163 +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
164 +4. Push to the Branch (`git push origin feature/AmazingFeature`)
165 +5. Open a Pull Request
166 +
167 +
168 +
169 +<!-- LICENSE -->
170 +## License
171 +
172 +<!-- 라이센스 나중에 올리고 링크 수정 필요-->
173 +GPL-v3.0 라이센스를 적용합니다. 자세한 정보는 [License][license-url]를 확인해주세요.<br>
174 +
175 +
176 +
177 +<!-- CONTACT -->
178 +## Contact
179 +Taeyoung Kim - rlaxodud9809@khu.ac.kr<br>
180 +Jaeho Lee - dlwogh9344@khu.ac.kr
181 +
182 +
183 +Project Link: [http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject)
184 +
185 +
186 +
187 +<!-- ACKNOWLEDGEMENTS -->
188 +<!--## Acknowledgements
189 +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
190 +* [Img Shields](https://shields.io)
191 +* [Choose an Open Source License](https://choosealicense.com)
192 +* [GitHub Pages](https://pages.github.com)
193 +* [Animate.css](https://daneden.github.io/animate.css)
194 +* [Loaders.css](https://connoratherton.com/loaders)
195 +* [Slick Carousel](https://kenwheeler.github.io/slick)
196 +* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
197 +* [Sticky Kit](http://leafo.net/sticky-kit)
198 +* [JVectorMap](http://jvectormap.com)
199 +* [Font Awesome](https://fontawesome.com)-->
200 +
201 +
202 +
203 +
204 +
205 +<!-- MARKDOWN LINKS & IMAGES -->
206 +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
207 +<!--[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
208 +[contributors-url]: http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/graphs/master/contributors
209 +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
210 +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
211 +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
212 +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
213 +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
214 +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
215 +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
216 +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
217 +[linkedin-url]: https://linkedin.com/in/othneildrew -->
218 +
219 +[license-url]: http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/blob/master/LICENSE.txt
220 +[product-screenshot1]: ./readme_img/1.png
221 +[product-screenshot2]: ./readme_img/2.png
222 +[product-screenshot3]: ./readme_img/3.png
......