Commits

Denis Darii committed ffe68db

inserted some links to the documentation in README.rst

  • Participants
  • Parent commits a873668

Comments (0)

Files changed (1)

 
 **Simple and Lightweight but Powerful and Open Source CMS only for e1337 people.**
 
+
 The project code and bugtracker is hosted on
 `Bitbucket <https://bitbucket.org/DNX/django-e1337cms/>`_ and `Github <https://github.com/DNX/django-e1337cms/>`_.
 
 
+Here the full documentation: `e1337cms.rtfd.org <http://e1337cms.rtfd.org/>`_.
+
+
 ============
 Installation
 ============
 
-There are a few different ways to install **e1337cms**:
+`here the documentation <http://e1337cms.readthedocs.org/en/latest/getting_started.html#installation>`_.
 
-Using pip
----------
-If you have pip install available on your system, just type::
 
-    pip install django-e1337cms
+==================================
+How to configure and use e1337cms?
+==================================
 
-If you've already got an old version of **e1337cms**, and want to upgrade, use::
-
-    pip install -U django-e1337cms
-
-Installing from a directory
----------------------------
-If you've obtained a copy of **e1337cms** using either Mercurial or a downloadable
-archive, you'll need to install the copy you have system-wide. Try running::
-
-    python setup.py develop
-
-If that fails, you don't have ``setuptools`` or an equivalent installed;
-either install them, or run::
-
-    python setup.py install
-
-
-==============================
-How to use e1337cms?
-==============================
-
-If you have already installed e1337cms, you must proceed with the
-configuration of your project.
-
-Configuration
--------------
-very simple, in three steps:
-
-#. Add **e1337cms** To INSTALLED_APPS
-
-#. Include the 'e1337cms.urls' urlpatterns at the end of your urlpatterns.
-
-#. Optional: Modify Your settings.py, declare your **INDEX_PAGE_SLUG** and **RST_SETTINGS** settings.
-
-Below the long explanation of each step...
-
-Add e1337cms To INSTALLED_APPS
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-As with most Django applications, you should add **e1337cms** to the INSTALLED_APPS within your settings file (usually *settings.py*).
-
-Example::
-
-    INSTALLED_APPS = [
-        'django.contrib.admin',
-        'django.contrib.auth',
-        'django.contrib.contenttypes',
-        'django.contrib.sessions',
-        'django.contrib.sites',
-
-        # Added.
-        'e1337cms',
-    ]
-
-Include the 'e1337cms.urls'
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You need to include the 'e1337cms.urls' urlpatterns at the end of your
-urlpatterns::
-
-    url(r'^', include('e1337cms.urls')),
-
-example::
-
-    from django.conf.urls import patterns, include, url
-    from django.contrib import admin
-    admin.autodiscover()
-
-    urlpatterns = patterns('',
-        url(r'^admin/', include(admin.site.urls)),
-        url(r'^', include('e1337cms.urls')),
-    )
-
-Optional: modify Your settings.py
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Within your *settings.py*, you’ll need to add some settings in order to
-personalize the **e1337cms** behaviour for your project.
-
-You can define:
-
-- **INDEX_PAGE_SLUG** - a string, the page slug to be rendered when no another slug is passed (*default:* **'home'**)
-- **RST_SETTINGS** - a dict, using this option you can pass additional settings as dictionary through the rst template block to the underlying docutils.core.publish_parts function. (*default:* **{}**)
-
+`here about how to configure and use <http://e1337cms.readthedocs.org/en/latest/getting_started.html#how-to-use-e1337cms>`_.
 
 
 =====================================
 How can I try e1337cms functionality?
 =====================================
 
-#. Obtain a copy of **e1337cms** repo::
-
-    $ hg clone ssh://hg@bitbucket.org/DNX/django-e1337cms
-
-#. Navitate in **testsite** folder inside this repo::
-
-    $ cd django-e1337cms/testsite/
-
-#. Create a virtualenv::
-
-    $ virtualenv /tmp/e1337cmsenv/
-
-#. Activate the virtualenv::
-
-    $ source /tmp/e1337cmsenv/bin/activate
-
-#. Install all requirements::
-
-    $ pip install -r requirements.txt
-
-#. Do a **syncdb**::
-
-    $ python manage.py syncdb
-
-#. Migrate the db::
-
-    $ python manage.py migrate
-
-#. Start the server::
-
-    $ python manage.py runserver
-
-#. Open a browser and navigate to *http://localhost:8000*.
-
-#. Navigate to *http://localhost:8000/admin/e1337cms/page/add/* to add some pages.
-
+`here about how to try e1337cms <http://e1337cms.readthedocs.org/en/latest/try_e1337cms.html>`_.
 
 
 ==============================
 Some examples of page content
 ==============================
 
-The content will be rendered as a django template.
-The "rst" blocks will be passed to *docutils* and converted to html.
-
-Page with rst block
--------------------
-content::
-
-    {% load e1337tags %}
-    {% rst %}
-    My h1 row
-    =========
-    {% endrst %}
-    another content, bla, <strong>blu</strong>, bli...
-
-Page which extends a template
------------------------------
-content::
-
-    {% extends "base.html" %}
-    {% load e1337tags %}
-    {% block title %}e1337::{{ page.title }}{% endblock title %}
-
-    {% block body %}
-    {% rst %}
-    My h1 row
-    =========
-    {% endrst %}
-    another content, bla, <strong>blu</strong>, bli...
-    <p>html content</p>
-
-    {% endblock body %}
+`here some examples <http://e1337cms.readthedocs.org/en/latest/some_examples.html>`_.
 
 
 =======
 Authors
 =======
 
-- **Denis Darii**
+`here the authors <http://e1337cms.readthedocs.org/en/latest/authors.html>`_.
 
 
 =======
 Credits
 =======
 
-Special thanks to the authors and contributors of this projects:
-
-- **Django**
-- **docutils**
+`here the credits <http://e1337cms.readthedocs.org/en/latest/credits.html>`_.
 
 
 =========
 Changelog
 =========
 
-0.0.2
------
-
-* added initial South migration
-* enabled South in testsite project
-* updated the documentation
-
-0.0.1
------
-
-* initial functionality
+`here the changelog <http://e1337cms.readthedocs.org/en/latest/changelog.html>`_.