Skip to content

Commit 0a9c809

Browse files
authored
Created README
Created README file.
1 parent 5bda1db commit 0a9c809

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# About
2+
3+
4+
5+
Sortify is an app that helps you recycle . In many cases people don’t recycle because it can be hard to know how to dispose of things correctly . Sortify solves this problem by sorting out your recycling for you . Simply take a picture of the item and the app will provide you with recycling instructions .
6+
7+
8+
9+
# Getting Started
10+
11+
The Test Release of the app can be found [here](https://github.com/paulpall/Sortify/releases)! Follow the instructions provided on the page .
12+
13+
# Usage
14+
15+
## Start Screen:
16+
17+
When the app is started you will be faced with two options. Sortify Discover™ that lists all known recyclable objects along with the respective recycling guidances; and Sortify Camera™ that lets the user capture an object & provides relevant information in return.
18+
19+
## Sortify Discover:
20+
21+
In the Discover view the user can scroll up and down to browse through different recyclable items.
22+
23+
## Sortify Camera:
24+
25+
In the Camera view it first goes to the phone's camera to take a picture . Once the picture has been taken the app gives possible items in the picture and how to recycle them .
26+
27+
# License
28+
29+
Distributed under the MIT License. See [`LICENSE`](https://github.com/paulpall/Sortify/blob/master/LICENSE) for more information.
30+
31+
# Contact
32+
33+
Paul Johannes Aru - [@paulpall](https://github.com/paulpall) - pauljohannes.aru@gmail.com
34+
35+
Abdul Basit - [@abdjava](https://github.com/abdjava) - ababdulbasit5@gmail.com
36+
37+
Project Link: [https://github.com/paulpall/Sortify](https://github.com/paulpall/Sortify)
38+
39+
40+
41+
# Acknowledgements
42+
43+
- Recycling Information Gathered from North London Waste Authority.
44+
- Recycling Icon & Logo designed by Pixel perfect from Flaticon.
45+
- Camera Icon designed by Freepik from Flaticon.
46+
- Sample code for Google Cloud Vision.

0 commit comments

Comments
 (0)