Merge pull request #4304 from benjaoming/readme-to-rst

Convert README to RST (compatible with sphinx and PyPi), move badges

MANIFEST.in.dist

@@ -3,7 +3,7 @@
 
 include kalitectl.py
 include LICENSE
-include README.md
+include README.rst
 include setup.cfg
 include requirements.txt
 

README.rst

@@ -0,0 +1,70 @@
+KA Lite
+=======
+
+by `Foundation for Learning Equality <https://learningequality.org/>`__
+
+|Build Status| |Coverage Status| |Docs|
+
+.. |Build Status| image:: https://circleci.com/gh/learningequality/ka-lite/tree/develop.svg?style=svg
+   :target: https://circleci.com/gh/learningequality/ka-lite/tree/develop
+
+.. |Coverage Status| image:: https://coveralls.io/repos/learningequality/ka-lite/badge.svg
+   :target: https://coveralls.io/r/learningequality/ka-lite
+
+.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
+   :target: http://ka-lite.readthedocs.org/
+
+`Khan Academy <http://www.khanacademy.org/>`__'s core mission is to
+"provide a free world-class education for anyone anywhere", and as `70%
+of the world's population is without access to the
+internet <http://en.wikipedia.org/wiki/Global_Internet_usage>`__,
+primarily in the developing world, providing an alternative delivery
+mechanism for Khan Academy content is key to fulfilling this mission.
+
+`KA Lite <http://kalite.learningequality.org/>`__ is a lightweight
+`Django <https://www.djangoproject.com/>`__ web app for serving core
+Khan Academy content (videos and exercises) from a local server, with
+points and progress-tracking, without needing internet connectivity.
+
+Primary use cases include:
+--------------------------
+
+-  For servers/\ **computer labs located in remote schools**, which
+   could be slowly syncing with a central server over a cell/satellite
+   network or via USB keys.
+-  In **correctional facilities** and other environments where providing
+   educational materials is of value, but users cannot be given general
+   internet access.
+-  **Mobile school "vans"**, which transport a server and multiple
+   laptops/tablets between a number of schools (or orphanages, community
+   centers, etc) in remote communities on a rotating basis, and syncing
+   up with a central database (to download new content and upload
+   analytics) when in an area with internet connectivity.
+
+We would love for you to get involved!
+--------------------------------------
+
+-  Learn how you can contribute code on our `KA Lite GitHub Wiki <https://github.com/learningequality/ka-lite/wiki>`__
+-  Report bugs by `creating issues <https://github.com/learningequality/ka-lite/wiki/Report-Bugs-by-Creating-Issues>`__
+-  Read more about the project's motivation at `Introducing KA Lite, an offline version of Khan
+   Academy <http://jamiealexandre.com/blog/2012/12/12/ka-lite-offline-khan-academy/>`__.
+
+Contact Us
+^^^^^^^^^^
+
+Tell us about your project and experiences!
+
+-  Email: info@learningequality.org
+-  Add your project to the map: https://learningequality.org/ka-lite/map/
+
+License information
+-------------------
+
+The KA Lite sourcecode itself is open-source `MIT
+licensed <http://opensource.org/licenses/MIT>`__, and the other included
+software and content is licensed as described in the
+`LICENSE <https://raw.github.com/learningequality/ka-lite/master/LICENSE>`__
+file. Please note that KA Lite is not officially affiliated with, nor
+maintained by, Khan Academy, but rather makes use of Khan Academy's open
+API and Creative Commons content, which may only be used for
+non-commercial purposes.

docs/index.rst

@@ -6,8 +6,12 @@
 KA Lite Documentation
 ===================================
 
-Welcome to the KA Lite Documentation page! Here, you will find all the information needed to set up the KA Lite software. Additionally, there's information on how to manage KA Lite and how to perform role-specific tasks. If you have any questions that are not addressed by the documentation and you have access to the Internet, please be sure to check our `FAQ`_ or `Forums`_!    
-
+Welcome to the KA Lite Documentation page! Here, you will find all the 
+information needed to set up the KA Lite software. Additionally, there's 
+information on how to manage KA Lite and how to perform role-specific 
+tasks. If you have any questions that are not addressed by the 
+documentation and you have access to the Internet, please be sure to 
+check our `FAQ`_ or `Forums`_!
 
 .. _FAQ: https://learningequality.org/ka-lite/faq/
 .. _Forums: https://forums.learningequality.org/
@@ -21,17 +25,5 @@ Welcome to the KA Lite Documentation page! Here, you will find all the informati
     Contributing and Development <developer_docs/contributing>
     For Devs <developer_docs/index>
 
-
-
-Contact Us
-==========
-
-We would love to hear about your project and experiences!
-
-**Email:**
-
-info@learningequality.org
-
-**Website:**
 
-http://learningequality.org
+.. include:: ../README.rst