Charles additions to .gitignore
[oweals/karmaworld.git] / README.md
1 ==========
2 KarmaWorld
3 ==========
4 __Description__: A django application for sharing and uploading class notes.
5
6 __Copyright__: FinalsClub, a 501c3 non-profit organization
7
8 __License__: GPLv3 except where otherwise noted
9
10 __Contact__: info@karmanotes.org
11
12 v3.0 of the karmanotes.org website from the FinalsClub Foundation
13
14
15
16
17 Purpose
18 =======
19
20 KarmaNotes is an online database of college lecture notes.  KarmaNotes empowers college students to participate in the free exchange of knowledge. 
21
22 Docs
23 ====
24
25 TODO: see `./docs/`
26 TODO: Put docs on [RTFD](https://readthedocs.org/)
27
28
29 Install
30 =======
31
32 TODO: see `./docs/source/os-install.rst`
33 TODO: Put docs on [RTFD](https://readthedocs.org/)
34
35
36 Thanks
37 ======
38
39 * KarmaNotes.org is a project of the FinalsClub Foundation with generous funding from the William and Flora Hewlett Foundation
40
41 * Also thanks to [rdegges](https://github.com/rdegges/django-skel) for the django-skel template