Permalink
Browse files

Refactoring and rewrote incstructions

  • Loading branch information...
1 parent d39ad6b commit ae2c8bf6aa2c628f81534c2d5bf3db53dc854e28 @adw0rd committed Oct 19, 2012
Showing with 46 additions and 36 deletions.
  1. +41 −31 README.rst
  2. +5 −2 marcus/urls.py
  3. +0 −3 urls.py
View
@@ -21,13 +21,13 @@ Examples
Screenshots:
-============
+=============
Сoming soon
Installation
-============
+=============
From PyPI:
------------
@@ -44,28 +44,30 @@ From sources:
virtualenv --no-site-packages venv
source venv/bin/activate
pip install -r requirements.txt
- python ./manage.py runserver 8000
-Common settings:
------------------
-::
+Configuration
+==============
+
+Add to ``settings.py``::
MARCUS_PAGINATE_BY = 20
MARCUS_ARTICLES_ON_INDEX = 10
MARCUS_COMMENTS_ON_INDEX = 10
MARCUS_COMMENT_EXCERPTS_ON_INDEX = 2
MARCUS_ITEMS_IN_FEED = 20
MARCUS_AUTHOR_ID = 1
-
MARCUS_TAG_MINIMUM_ARTICLES = 3
# Specify blog names:
from django.utils.translation import ugettext_lazy as _
MARCUS_TITLE = _('Blog')
MARCUS_SUBTITLE = _('Sample blog')
-
+
+ # You can specify extras for markdown:
MARCUS_MARKDOWN_EXTRAS = ['code-friendly', 'wiki-tables']
+
+ # You can specify #hashtag or @name as suffix for Twitter:
MARCUS_RETWEET_SUFFIX = "#marcus"
# Specify a fields which will used in search:
@@ -81,7 +83,11 @@ Common settings:
# Should not end with '/'.
# Complete site URL is passed if the value is empty.
SCIPIO_TRUST_URL = ''
- SCIPIO_AKISMET_KEY = '' # You can receive the key here https://akismet.com/signup/
+
+ # Akismet is a spam filtering service.
+ # Without the key will not work comments.
+ # You can receive the key here https://akismet.com/signup/
+ SCIPIO_AKISMET_KEY = ''
SCIPIO_USE_CONTRIB_SITES = True
@@ -112,6 +118,32 @@ Common settings:
)
+Add to ``urls.py``::
+
+ from django.conf.urls import patterns, include, url
+ from django.contrib.staticfiles.urls import staticfiles_urlpatterns
+ from django.contrib import admin
+
+ admin.autodiscover()
+
+ urlpatterns = patterns('',
+ url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
+ url(r'^admin/', include(admin.site.urls)),
+ url(r'^', include('marcus.urls')),
+ )
+
+ urlpatterns += staticfiles_urlpatterns()
+
+
+
+And run so::
+
+ python ./manage.py runserver 8000
+
+
+After installation, going to http://localhost:8000/admin/scipio/profile/ and create you profile.
+
+
Wordpress importer settings:
-----------------------------
@@ -139,25 +171,3 @@ It has a built-in pipelines for additional filtering data.
'www.my-old-blog-on-wordpress.org',
),
}
-
-Example of the ``urls.py``:
------------------------------
-::
-
- from django.conf.urls import patterns, include, url
- from django.contrib.staticfiles.urls import staticfiles_urlpatterns
- from django.contrib import admin
-
- admin.autodiscover()
-
- urlpatterns = patterns(
- '',
- url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
- url(r'^admin/', include(admin.site.urls)),
- url(r'^sitemap', include('marcus.sitemap_urls')),
- url(r'^', include('marcus.urls')),
- url(r'^', include('subhub.urls')),
- url(r'^', include('scipio.urls')),
- )
-
- urlpatterns += staticfiles_urlpatterns()
View
@@ -1,6 +1,6 @@
import pingdjack
-from django.conf.urls import patterns, url
+from django.conf.urls import patterns, include, url
from marcus import views, feeds
@@ -17,7 +17,6 @@
url(r'^archive/(\d{4})/(?:(\d{1,2})/)?(?:(en|ru)/)?$', views.archive, name='marcus-archive'),
url(r'^(\d{4})/(?:(en|ru)/)?$', views.archive_short, name="marcus-archive-short"),
-
url(r'^suspected/$', views.spam_queue, name='marcus-spam-queue'),
url(r'^suspected/approve/(\d+)/$', views.approve_comment, name='marcus-approve-comment'),
url(r'^suspected/spam/(\d+)/$', views.spam_comment, name='marcus-spam-comment'),
@@ -41,4 +40,8 @@
url(r'^([^/]+)/$', views.find_article, name='marcus-find-article'),
url(r'^articleuploadimage/preview/(\d+)/$', views.article_upload_image_preview, name="article-upload-image-preview"),
+ url(r'^sitemap', include('marcus.sitemap_urls')),
+
+ url(r'^', include('subhub.urls')),
+ url(r'^', include('scipio.urls')),
)
View
@@ -8,10 +8,7 @@
'',
url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
url(r'^admin/', include(admin.site.urls)),
- url(r'^sitemap', include('marcus.sitemap_urls')),
url(r'^', include('marcus.urls')),
- url(r'^', include('subhub.urls')),
- url(r'^', include('scipio.urls')),
)
urlpatterns += staticfiles_urlpatterns()

0 comments on commit ae2c8bf

Please sign in to comment.