aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4948ba4
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+gentoo-ads
+created by Matthew Summers and Richard Anderson of Liquidus Tech, LLC
+
+this is an ads (automated display system)
+written in python and using the django web framework
+
+It is licensed under the GPLv3 or greater.
+
+gentoo-ads has been tested with python-2.6.3 and django-1.1.1
+but should work just fine on python-2.5 and django-1.0.x.
+There are no other direct dependencies.
+
+The gentoo-ads 'ads' module uses a simple random weighted subset method
+to choose the object to display.
+
+To get started simply:
+$ cd gentoo_ads
+$ cp example_settings.py settings.py
+
+Edit the CONFIG_PATH in settings.py to point to your copy of example_ads.py
+
+Then run the django development webserver via
+$ python manage.py runserver
+
+Finally, navigate your browser to http://localhost:8000 to view the display results. \ No newline at end of file