diff --git a/README b/README index e69de29..ee4010a 100644 --- a/README +++ b/README @@ -0,0 +1,34 @@ +GitLog is gitoris administration tool and repository browser build on django. + +Python version must be greater than or equal to **2.6** + + +Requirements +--- +- Django >= 1.3 +- Pygments >= 1.4 +- GitPython >= 0.3.2 +- ConfigObj >= 4.7.2 +- Makrdown >= 2.0.3 +- South >= 0.7.2 + +Instalation +--- + +1. Register these following applications in the INSTALLED_APPS section of your project’s settings + > 'gitlog', 'django.contrib.markup', +2. Add these following template context processors if not already present. + > 'django.core.context_processors.static' +4. Run following commands + + > python manage.py syncdb --all + > python manage.py migrate --fake + > python manage.py collectstatic + + > sudo python manage runserver + + +Configuration +--- +See **gitlog/settings.py** for available settings. + diff --git a/setup.py b/setup.py index 6e04fd4..172bb84 100644 --- a/setup.py +++ b/setup.py @@ -18,6 +18,6 @@ packages=['gitlog', 'gitlog.templatetags'], package_data={ 'gitlog' : ['templates/gitlog/*.html', 'templates/gitlog/repositories/*.html', 'templates/gitlog/account/*.html']}, zip_safe=False, - install_requires=['GitPython >=0.3.2', 'Pygments >=1.4', 'Django >=1.3', 'ConfigObj >=4.7.2', 'Makrdown >=2.0.3'], + install_requires=['GitPython >=0.3.2', 'Pygments >=1.4', 'Django >=1.3', 'ConfigObj >=4.7.2', 'Makrdown >=2.0.3', 'south>=0.7.2'], )