From ce34623ee6d03facb1facb2d786ee75812130810 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yaroslav=20de=20la=20Pe=C3=B1a=20Smirnov?= Date: Wed, 18 Jul 2018 02:38:37 +0300 Subject: Readme update --- README.md | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b9cd3ed..fcf365a 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Weblog version 0.3 # +# Weblog version 0.4 # Weblog is a simple blog engine for Django, with some focus on multilingual capabilities. It includes all of the basic features expected of a traditional Web log (also known as blog), as well as multilingual features, i.e. translations of blog posts which are delivered automatically in the user's preferred language using the internationalization capabilities of Django, enabling the possibility of targeting people from different countries in a single blog/site. @@ -9,28 +9,34 @@ This django app is still a work in progress. More features will be added/complet 1. Add "weblog" to your INSTALLED_APPS setting in your settings.py -2. Include the app in your project's urls.py; for example: +2. Include the app as well as django-summernote in your project's urls.py; for example: - url(r'^blog/', include('weblog.urls')), +```python +url(r'^blog/', include('weblog.urls')), +url(r'^summernote/', include('django_summernote.urls')), +``` 3. Migrate the models to the database by running "python manage.py migrate" 4. You can configure and customize the blog by adding and modifying to your liking/needs the following settings to your settings.py: - WEBLOG_SETTINGS = { - 'enable_comments': False, - 'allow_anon_comments': False, - 'multilingual': True, - 'blog_title': 'Django-Weblog', - 'base_template': 'weblog_base.html', - 'show_author': True, - 'use_authors_username': True, - 'show_sidebar': True, - 'show_categories': False, - 'show_archive': True, - 'posts_per_page': 10, - } - -5. Note that if you use your own base template, you will either need to link bootstrap (v3.2 at the moment) in your base template's head, or write your own styles for the site based on the bootstrap classes. You will as well need to link files "weblog/css/weblog.css" and "weblog/js/weblog.js" in your html head, or write your own. +```python +WEBLOG_SETTINGS = { + 'enable_comments': False, + 'allow_anon_comments': False, + 'multilingual': True, + 'blog_title': 'Django-Weblog', + 'base_template': 'weblog_base.html', + 'show_author': True, + 'use_authors_username': True, + 'show_sidebar': True, + 'show_categories': False, + 'show_archive': True, + 'posts_per_page': 10, + 'enable_rss': True, +} +``` + +5. Note that if you use your own base template, you will either need to link Bootstrap (v4) in your base template's head, or write your own styles for the site based on the bootstrap classes. You will as well need to link files "weblog/css/weblog.css" and "weblog/js/weblog.js" in your html head, or write your own. Note: This package depends on the following python packages (besides Django and their dependencies): django-summernote -- cgit v1.2.3