Skip to content
This repository has been archived by the owner on Jan 18, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
final
  • Loading branch information
clennam authored Oct 21, 2017
1 parent 53b2f9a commit 95c531c
Showing 1 changed file with 43 additions and 6 deletions.
49 changes: 43 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
This is the repository for Team Diaspora's data crowdsourcing app for the [Google NLU Challenge, Sri Lanka](https://goo.gl/Dx4ozJ), named **Forager**.

##### Contents
[Google NLU Challenge](#challenge)
[Google NLU Challenge](#challenge)
[App Concept](#concept)
[How To Use](#howto)
[How To Play](#howto)
[Team Diaspora](#aboutus)

### <a name="challenge"></a>Google NLU Challenge
Expand All @@ -17,13 +17,50 @@ Team Diaspora was selected as one of the final four teams from Sri Lanka to do t
### <a name="concept"></a>Concept
A big focus for our project was gamification of what would otherwise be a boring task, so we eventually came up with the concept of a tribe undertaking a long journey to find a new home.

### <a name="howto"></a>How to Use
The player, as a newly minted brave of this new tribe, must help the tribe survive as they move towards their promised land. They do this by foraging around the surrounding area, which we represented by the retrieval and rating of comments) for food, as the tribe moves along on their journey. For every good judgement you make, you bring the tribe closer to the end of their journey. For every bad judgement you make, you add more distance to the journey your tribe must travel. **This means that every decision you make is real, and that your errors will affect everyone playing.**

### <a name="howto"></a>How to Play

#### Login/Signup
![Login/Signup screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/login_signup.png)

The first time you enter the app, it will present you with a choice between logging in and signing up. From here you can either choose to sign up: (*Please note*: The password has to be a minimum of six characters.)

![Signup screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/signup.png)

If you've already signed up, you can just log in manually.

![Login screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/login.png)

#### Main Menu
If you're already logged in, this is the first screen you'll see, from where you can access all the app's features.

![Main menu screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/main_menu.png)

#### Start Game
![Game screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/main_menu.png)

This is the main game activity. Your task here is to read the comment presented to you and rate it on the bases provided, explained in detail below:

- Toxic - Is the comment promoting a generally toxic environment towards everyone
- Insulting - Is the comment insulting the person/s it is aimed at?
- Obscene - Does the comment have a lot of profanity?
- Threatening: Is the comment threatening towards the person it is aimed at?
- Identity Hate: Is the comment hateful or derogatory towards a group of people or identity?

#### Community
![Community page screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/community.png)

The amount of comments left to reach the target can be viewed at any time from the Community Page, so that you can see how your contributions are helping reach the target.

#### Account Settings
![Account settings page screenshot](https://raw.githubusercontent.com/moizalicious/Forager/master/docs/screenshots/account_details.png)

From this screen you can handle various operations associated with your account.

### <a name="aboutus"></a>Team Diaspora
Team Diaspora is a team of three undergraduates from [Informatics Institute of Technology](http://www.iit.ac.lk/), comprised of Byung ["Dzolver"](https://github.com/dzolver) Charn Lee, Moiz ["moizalicious"](https://github.com/moizalicious) Mansoor Ali and Aishcharya ["clennam"](https://github.com/clennam) Mario Kahandawala.

The amount of comments left to reach the target can be viewed at any time from the Community Page, so that you can see how your contributions are helping us reach the target.

As additional incentive, we will also be donating a portion of the prize money to charity.
The information you contribute will be used to create a better, harassment-free environment on the internet for everyone. As additional incentive, we will also be donating a portion of the prize money obtained to charity.

Please download the .apk supplied to start contributing, and good luck!

0 comments on commit 95c531c

Please sign in to comment.