Skip to content

Commit

Permalink
Merge pull request #55 from GDSC-DEU/docs/#40-improve-readme
Browse files Browse the repository at this point in the history
`README.md` 개선
  • Loading branch information
solo5star authored Jun 4, 2022
2 parents 8a646b0 + c3279bd commit 02616a6
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 17 deletions.
45 changes: 28 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
<div align="center">

<img src="./resources/candrink.png" width="200" height="200">

<!-- omit in toc -->
# 2022-SolutionChallenge-CanDrink

This project is **CanDrink**, a canned drink recognition service for the visually impaired.
We are aim to a world where blind people have free from the inconvinience of failure of recognizing cans.

</div>

<br>
<br>

## Summary

Of the many canned drinks, there are only two types of drinks that can be classified in braille: 'just drink' and 'soda'. This is what canned drinks look like from a blind person's point of view. So we created a service that helps visually impaired people choose their favorite drinks.


**[YouTube Link](https://www.youtube.com/embed/zg14ulTd5mM)**
You can see more detail on **[Intoduction YouTube Link](https://www.youtube.com/embed/zg14ulTd5mM)**!

<br><br>

<!-- omit in toc -->
# [ANNOUNCE] Congrats!! This project has been shortlisted to the global TOP 50!

![image](https://user-images.githubusercontent.com/20203944/170526199-496c7776-de75-4b18-bf48-9ff3611289b4.png)
Click image to see more detail!

[![image](https://user-images.githubusercontent.com/20203944/170526199-496c7776-de75-4b18-bf48-9ff3611289b4.png)](https://developers.google.com/community/gdsc-solution-challenge/winners)

<br><br>

Expand All @@ -27,18 +37,18 @@ Of the many canned drinks, there are only two types of drinks that can be classi
- [Installation](#installation)
- [Run](#run)
- [Directory](#directory)
- [LICENSE](#license)
- [Architecture](#architecture)
- [Object Detection](#object-detection)
- [Barcode Detection](#barcode-detection)
- [CanDrink Client](#candrink-client)
- [Getting Started](#getting-started-1)
- [Prerequisite](#prerequisite)
- [Installation](#installation-1)
- [Run](#run-1)
- [LICENSE](#license-1)
- [Crawler](#crawler)
- [Getting Started](#getting-started-2)
- [Installation](#installation-2)
- [Run](#run-2)
- [LICENSE](#license-2)
- [ML Notebook](#ml-notebook)
- [Environment](#environment)
- [Setup CUDA](#setup-cuda)
Expand Down Expand Up @@ -83,9 +93,18 @@ app
├─ run.py
```

## LICENSE
<br><br>

# Architecture

[MIT License](./LICENSE)
## Object Detection
Object detection is run with TensorFlow Lite. Model files will be distributed with constant updates. Therefore, we added deploy server for model file distribution. Client checks model is updated and download from server.

![architecture-about-object-detection](./resources/architecture-about-object-detection.png)

## Barcode Detection

![architecture-about-barcode-detection](./resources/architecture-about-barcode-detection.png)

<br><br>

Expand Down Expand Up @@ -115,10 +134,6 @@ And you can see VSCode with this project.

Press `F5` to run on VSCode.

## LICENSE

[MIT License](./LICENSE)

<br><br>

# Crawler
Expand Down Expand Up @@ -146,10 +161,6 @@ echo "NAME=[forlder name]" >> .env
python crawler.py
```

## LICENSE

[MIT License](./LICENSE)

<br><br>

# ML Notebook
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/candrink.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions resources/candrink.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/draft.pptx
Binary file not shown.

0 comments on commit 02616a6

Please sign in to comment.