Update common.txt

[oweals/karmaworld.git] / README.md

diff --git a/README.md b/README.md
index 90d9af3568d49a025e2edbd33995e5183efc73bc..d0256c9817034c39987544da39ec308801229838 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,41 @@
-karmaworld
 ==========
+KarmaWorld
+==========
+__Description__: A django application for sharing and uploading class notes.
+
+__Copyright__: FinalsClub, a 501c3 non-profit organization
+
+__License__: GPLv3 except where otherwise noted
+
+__Contact__: info@karmanotes.org
+
+v3.0 of the karmanotes.org website from the FinalsClub Foundation
+
+
+
+
+Purpose
+=======
+
+KarmaNotes is an online database of college lecture notes.  KarmaNotes empowers college students to participate in the free exchange of knowledge. 
+
+Docs
+====
+
+TODO: see `./docs/`
+TODO: Put docs on [RTFD](https://readthedocs.org/)
+
+
+Install
+=======
+
+TODO: see `./docs/source/os-install.rst`
+TODO: Put docs on [RTFD](https://readthedocs.org/)
+
+
+Thanks
+======
+
+* KarmaNotes.org is a project of the FinalsClub Foundation with generous funding from the William and Flora Hewlett Foundation
 
-KarmaNotes.org v3.0
\ No newline at end of file
+* Also thanks to [rdegges](https://github.com/rdegges/django-skel) for the django-skel template