Skip to content

Commit 616b3ee

Browse files
Update README.md
1 parent 0559eed commit 616b3ee

File tree

1 file changed

+50
-23
lines changed

1 file changed

+50
-23
lines changed

README.md

Lines changed: 50 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,65 @@
11
#Discovery Cat
22

3-
Discovery cat is a game that will help users to discover their appropriate digital and learning preferences in an interactive environment by engaging them in a process of “**Learning to learn**”.
3+
Discovery cat is a game that will help users to discover their appropriate digital and learning preferences. Preferences are choices made by users, according to their needs of how they want to consume their resources. For example the size preference of a user will tell us if the user likes to see content in small size, normal size or large size. Other preference might tell us if the user is comfortable with black text on white screen or white text on black screen. Knowing all the different preferences of users, we can provide them with a seemless, consistent and comfortable experience. The objective of the game is to discover users preferences.
4+
The game will engage the users in a process of “**Learning to learn**”. This is a methodology where users can themselves try and learn what preferences work best for them.
45

5-
###Libraries
6+
The project is an outcome of IDRC's participation in Google Summer of Code (GSOC) 2016. It is one of many projects made by involved students during the summers under guidance of IDRC community members.
67

7-
The game is made using -
8+
##Setup
89

9-
1. [Phaser](http://www.phaser.io)
10-
2. [Infusion](https://www.npmjs.com/package/infusion)
10+
Follow these steps -
1111

12-
###Setup
12+
1. Download and install [npm](https://npmjs.org/). The easiest way to do this is to just install [node](http://nodejs.org/). Open the node cli.
13+
2. Install [Grunt](http://gruntjs.com/getting-started).
14+
15+
```
16+
npm install -g grunt-cli
17+
```
1318

14-
Follow these steps -
19+
3. Clone this repository.
1520

16-
1. Open node cli and run `npm install`.
17-
2. Use `grunt dev` to start server.
18-
3. Browse to `http://localhost:8000` in any browser.
19-
4. Select demo folder in the directory to run the game.
21+
```
22+
git clone https://github.com/PaliwalSparsh/Discovery-Cat
23+
```
2024

21-
###Development
25+
4. Navigate into the project folder and install dependencies via npm.
26+
27+
```
28+
cd Discovery-Cat/
29+
npm install
30+
```
31+
32+
5. Start server using grunt.
33+
34+
```
35+
grunt dev
36+
```
37+
38+
6. Open a browser of your choice and browse to
39+
40+
```
41+
http://localhost:8000/demo/
42+
```
43+
44+
to run the game.
45+
46+
47+
##Issues
48+
49+
You can post bugs found in Discovery Cat itself here:
50+
[https://github.com/PaliwalSparsh/Discovery-Cat/issues](https://github.com/PaliwalSparsh/Discovery-Cat/issues)
51+
52+
53+
##Get Involved
54+
55+
We would love to have you work with us. Check out the [development](https://github.com/PaliwalSparsh/Discovery-Cat/wiki/Development) wiki page for more in-depth details about contributing code and fixing bugs.
2256

23-
Follow these steps -
2457

25-
1. Open node cli and run `npm install`.
26-
2. Use `grunt dev` in cli. This will do the following-
27-
- Start a server at `http://localhost:8000`.
28-
- Keeps watching files for changes.
29-
- Perform livereload on saves.
30-
- Run jshint and jscs on saves.
58+
##Contributors
3159

32-
####Possible grunt operations
60+
IDRC Fluid community.
3361

34-
1. `grunt lint` - performs linting ( both jshint and jscs) seperately.
35-
2. `grunt jshint` - uses jshint to analyse code for potential errors.
36-
3. `grunt jscs` - uses jscs for codestyle linting.
3762

63+
##License
3864

65+
BSD 3-Clause License

0 commit comments

Comments
 (0)