Luke Plant avatar Luke Plant committed 6575376

Renamed README to make it easier for Windows users

Comments (0)

Files changed (2)

README

-== Family Fortunes ==
-
-(a.k.a. Family Feud)
-
-A simple implementation of the LED score board for Family Fortunes, with
-sound effects.  It needs a human to read questions and make judgements about
-whether an answer is right or not. A simple set of keyboard controls is used
-to control it.
-
-=== Requirements ===
-
-All that is needed is a modern web browser. Tested in:
-
- Firefox 4
- Chrome 10
- Opera 10
-
-Assumes a screen size of about 1024 x 768 or bigger.
-
-=== Use ===
-
-Simply download all the files into a folder, and open up 'index.html' in the web
-browser. Put browser in full screen mode. Then use the following keys.
-
- n - next question
- p - previous question
- 1 - 5  - correct answer (press again to remove toggle)
- x - wrong answer
- z - remove a wrong answer
- Space - wrong answer, without losing a life
-        (if there is a wrong answer in the first deciding phase)
-
-=== Questions ===
-
-Questions and answers are stored in the file data.json. (To avoid XHR
-restrictions on localhost, it is strictly javascript, not json). The format
-is obvious:
-
- [
-  ["Question 1",
-   ["Answer 1",
-    "Answer 2",
-    "Answer 3",
-    "Answer 4",
-    "Answer 5"],
-  ],
-  ["Question 2", ...
-  ]
- ]
-
-== Licence ===
-
-A number of files from differnt sources are bundled:
-
-data.json - includes questions scraped from free questions here:
-            http://www.pub-quiz.net/Family-Fortunes-quiz.htm
-
-jquery-1.6.js - MIT/GPL licence
-
-Sound effects - recorded from TV program, assumed "fair use".
-
-BPDots.otf - Font from http://www.backpacker.gr/
-             Creative Commons Licence
-
-The remaining file (game.html) is original, and free to use and modify
-under the MIT licence.
+== Family Fortunes ==
+
+(a.k.a. Family Feud)
+
+A simple implementation of the LED score board for Family Fortunes, with
+sound effects.  It needs a human to read questions and make judgements about
+whether an answer is right or not. A simple set of keyboard controls is used
+to control it.
+
+=== Requirements ===
+
+All that is needed is a modern web browser. Tested in:
+
+ Firefox 4
+ Chrome 10
+ Opera 10
+
+Assumes a screen size of about 1024 x 768 or bigger.
+
+=== Use ===
+
+Simply download all the files into a folder, and open up 'index.html' in the web
+browser. Put browser in full screen mode. Then use the following keys.
+
+ n - next question
+ p - previous question
+ 1 - 5  - correct answer (press again to remove toggle)
+ x - wrong answer
+ z - remove a wrong answer
+ Space - wrong answer, without losing a life
+        (if there is a wrong answer in the first deciding phase)
+
+=== Questions ===
+
+Questions and answers are stored in the file data.json. (To avoid XHR
+restrictions on localhost, it is strictly javascript, not json). The format
+is obvious:
+
+ [
+  ["Question 1",
+   ["Answer 1",
+    "Answer 2",
+    "Answer 3",
+    "Answer 4",
+    "Answer 5"],
+  ],
+  ["Question 2", ...
+  ]
+ ]
+
+== Licence ===
+
+A number of files from differnt sources are bundled:
+
+data.json - includes questions scraped from free questions here:
+            http://www.pub-quiz.net/Family-Fortunes-quiz.htm
+
+jquery-1.6.js - MIT/GPL licence
+
+Sound effects - recorded from TV program, assumed "fair use".
+
+BPDots.otf - Font from http://www.backpacker.gr/
+             Creative Commons Licence
+
+The remaining file (game.html) is original, and free to use and modify
+under the MIT licence.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.