Skip to content

Commit

Permalink
Merge pull request #10 from c-w/patch-1
Browse files Browse the repository at this point in the history
Fix heading formatting
  • Loading branch information
alexgreene committed May 11, 2017
2 parents 9b0a9a2 + d3cb582 commit 63f7a5f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

![alt tag](http://i.imgur.com/Bx7l18S.png)

##Acknowledgements
## Acknowledgements
Credit to Volley (http://volley.com) for requesting/inspiring this project!

##To run:
## To run:
requirements.txt contains the libraries/modules you'll need (It's come to my attention that the Wikipedia library has a bug, so I recommend this instead: http://stackoverflow.com/questions/34869597/wikipedia-api-for-python#35122688). You'll also need to download some data so that the nltk library works. To do this, start the Python console (ie. type `python` on the command line) and then:

>>> import nltk
Expand All @@ -14,7 +14,7 @@ requirements.txt contains the libraries/modules you'll need (It's come to my att

Run server.py to get the Flask endpoints working, and then open up index.html - that's all!

##Potential Future Improvements:
## Potential Future Improvements:
Choosing more appropriate multiple-choice options, especially for numbers

_ie. if the answer is '1960s', show '1950s' as another option._
Expand All @@ -27,7 +27,7 @@ Some of the questions presented currently lack context about what the question i

_ie. references to 'they' or 'he' would be replaced by what those pronouns are actually referring to._

##Known limitations:
## Known limitations:
The Python script will not handle certain Wikipedia pages correctly ("Harry Potter" for example). Most likely due to how I'm iterating through the parsed token tree in create_questions in Article.py. Certain articles have disambiguations and I decided to leave handling these out of scope. For both of the above you'll see on the console that I'm just returning a 500 error. If working further on the project I'd fix these and create less overarching exception handling than the try/except in server.py


Expand Down

0 comments on commit 63f7a5f

Please sign in to comment.