Licensing and readme

This commit is contained in:
Ryan McGrath 2010-10-27 15:00:50 -04:00
parent d5c605e4ad
commit 0232d10a77
2 changed files with 56 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
The MIT License
Copyright (c) 2009 - 2010 Ryan McGrath
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

35
readme.md Normal file
View file

@ -0,0 +1,35 @@
Drinkkit
=========================================================================================
Drinkkit is a FourSquare/Gowalla "clone" written in Django (GeoDjango, to get specific).
It was written out of two needs/desires:
1) The author wanted to learn more geolocation crap.
2) The Stewart/Colbert Rallies in DC were largely pushed by the efforts of members from
Reddit.com, and there'll no doubt be massive bar crawls going on. It'd be cool if there
was an easier way for Redditors to get to know one another, so this is one solution.
It's optimized to run on just about *any* phone/device with an internet connection, and could
be expanded to work outside the DC metro area if someone wants to handle it.
Requires for Dev Work
=========================================================================================
Install GeoDjango (I leave this to you, as anything involving this is annoying)
Setup Postgres/PostGIS (see: annoying)
Sync and run this app
Documentation?
=========================================================================================
The source is fairly well documented and/or readable. If you have further questions, feel
free to open a ticket or email me directly.
Licensing, Contributions, Attributions, etc
=========================================================================================
This project is released under an MIT license. It was created by Ryan McGrath (ryan [at] venodesigns.net).
If you'd like to contribute patches or changes, simply fork and do a pull request when ready. I respond.
http://twitter.com/ryanmcgrath
http://venodesigns.net/