From b8d3c338f86d89c3ba75129ee777be48faa14a66 Mon Sep 17 00:00:00 2001 From: Kris Lamoureux Date: Sat, 13 Oct 2012 09:25:06 -0700 Subject: [PATCH] Updated README for readability --- README | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README b/README index fe4032b..01d8296 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ DJ-BaseSite was written in Python 2.7 and Django 1.4 Description: -DJ-BaseSite (or Django-BaseSite) is a customizable login and register system with required email activation. While most people just use django-registration, I decided to write my own to learn more about Django. +DJ-BaseSite is a customizable login and register system with required email activation. While most people just use django-registration, I decided to write my own to learn more about Django. NOTE TO DEVS: A deactivation system hasn't been added. The login system needs to check attempts and display a CAPTCHA after a certain amount, this isn't included either. It also doesn't have an account recovery option. I plan to implement all of these things in future updates. @@ -19,13 +19,31 @@ Instructions DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, so you'll need to get private and public keys from the website: http://www.google.com/recaptcha Configuration Variable Meanings. +=================================== +-baseurl +It is used to create activation and deactivation links [in views.py in register_user()] + +-admin_name/email +Adds a name and email to the ADMINS tuple in settings.py +http://docs.djangoproject.com/en/dev/ref/settings/#admins + +-secret_key +A string used to provide cryptographic signing. (don't use spaces due to the configurtion system) +https://docs.djangoproject.com/en/dev/ref/settings/#secret-key +http://www.random.org/passwords/?mode=advanced + +-captcha_publickey/privatekey +DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, get keys at http://www.google.com/recaptcha + +-HOSTsmpt +The SMPT server address with the email used to send activation emails. If your email doesn't support SMPT I highly suggest GMAIL. + +-HOSTemail +The email address + +-HOSTpass +The email's password +=================================== -baseurl - It is used to create activation and deactivation links ( in views.py in register_user() ) -admin_name/email - adds a name and email to the ADMINS tuple in settings.py ( http://docs.djangoproject.com/en/dev/ref/settings/#admins ) -secret_key - A secret randomly generated string of characters (don't use spaces) ( http://www.random.org/passwords/?mode=advanced ) -captcha_publickey/privatekey - DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, get keys at google.com/recaptcha -HOSTsmpt - The SMPT server address with the email used to send activation emails. If your email doesn't support SMPT I highly suggest GMAIL. -HOSTemail - The email address -HOSTpass - The email's password NOTE: It creates a development project, DEBUG is set to True in the settings.py so it is in no condition for deployment. \ No newline at end of file