Commits

catapela committed f6906cd

some changes in readme file

Comments (0)

Files changed (2)

 
 **Installation**
 
-    *Manual Installation*
+    *Download & installation with pip (recommended)*
 
-        * Download the file and unzip it.
-        * Copy the folder in your project root.
+        Pip will download and install the package and take care of all the dependences.
 
-    *Installation with pip*
+        * Use the stable release (recommended)
 
-        * Type in your terminal:
+            Type in your terminal:
         
-        ::
-        
-        :~$ pip install django-dynamic-link
+            ::
+
+            :~$ pip install django-dynamic-link
+
+        * Or the development version
+
+            Than type in your terminal:
+
+            ::
+
+            :~$ pip install -e hg+https://bitbucket.org/catapela/django-dynamic-link/#egg=django-dynamic-link
 
         * With pip you can also uninstall it:
 
 
         :~$ pip uninstall django-dynamic-link
 
+    *Manual Installation*
+
+        * To get the package from pypi (stable) or bitbucket (dev) see here_.
+
+.. _here: http://pypi.python.org/pypi/django-dynamic-link/#downloads
+
+        * Download the file and unzip it.
+        * Copy the folder in your project root.
+        * Make shure all package dependences are fulfilled.
+
     *Other possibilities*
 
         * Open a terminal and change to the folder which contains the setup.py and then type:
 
     Go to console and type:
 
-::
+    ::
 
     :~$ python
+
+    ... than type:
+    
     >>> import dynamicLink
     >>> dynamicLink.VERSION
-
+    
 =====
 Setup
 =====
+    
+    * Add "dynamicLink" to you installed apps in the settings file.
 
-    * Add "dynamicLink" to you installed apps in the settings file.
     * Make sure that:
         1.   'django.middleware.locale.LocaleMiddleware', is in your MIDDLEWARE_CLASSES.
-        2.   Your Admin is enabled ('django.contrib.admin', is in your INSTALLED_APPS)
+        2.   Your Admin is enabled ('django.contrib.admin', is in your INSTALLED_APPS).
         3.   'django.contrib.auth.context_processors.auth', (also for admin) is in TEMPLATE_CONTEXT_PROCESSORS.
         4.   'django.core.context_processors.request', is in TEMPLATE_CONTEXT_PROCESSORS.
+
     * Add the following to your urls.py:
         1.   from dynamicLink import presettings
         2.   (r'^\w+/%s/' % presettings.DYNAMIC_LINK_URL_BASE_COMPONENT, include('dynamicLink.urls')),
+    
     * Finally run:
 
     ::
 
 djang-dynamic-links ships with an example proect.
 
-    1. First unpack the tar.gz
-    2. Than move "dynamicLink" in to the "example" folder or install it (see install section).
-    3. Run "python manage.py syncdb" and "python manage.py runserver".
-    4. Open a Browser, go to: http://127.0.0.1:8000/
+    1. Install the package (see install section).
+    2. Run "python manage.py syncdb" and "python manage.py runserver".
+    3. Open a Browser, go to: http://127.0.0.1:8000/
 </blockquote>
 <p><strong>Installation</strong></p>
 <blockquote>
+<p><em>Download &amp; installation with pip (recommended)</em></p>
+<blockquote>
+<p>Pip will download and install the package and take care of all the dependences.</p>
+<ul>
+<li><p class="first">Use the stable release (recommended)</p>
+<blockquote>
+<p>Type in your terminal:</p>
+<pre class="literal-block">
+:~$ pip install django-dynamic-link
+</pre>
+</blockquote>
+</li>
+<li><p class="first">Or the development version</p>
+<blockquote>
+<p>Than type in your terminal:</p>
+<pre class="literal-block">
+:~$ pip install -e hg+https://bitbucket.org/catapela/django-dynamic-link/#egg=django-dynamic-link
+</pre>
+</blockquote>
+</li>
+<li><p class="first">With pip you can also uninstall it:</p>
+</li>
+</ul>
+<pre class="literal-block">
+:~$ pip uninstall django-dynamic-link
+</pre>
+</blockquote>
 <p><em>Manual Installation</em></p>
 <blockquote>
 <ul class="simple">
+<li>To get the package from pypi (stable) or bitbucket (dev) see <a class="reference external" href="http://pypi.python.org/pypi/django-dynamic-link/#downloads">here</a>.</li>
+</ul>
+</blockquote>
+</blockquote>
+<blockquote>
+<blockquote>
+<ul class="simple">
 <li>Download the file and unzip it.</li>
 <li>Copy the folder in your project root.</li>
+<li>Make shure all package dependences are fulfilled.</li>
 </ul>
 </blockquote>
-<p><em>Installation with pip</em></p>
-<blockquote>
-<ul>
-<li><p class="first">Type in your terminal:</p>
-<div class="system-message">
-<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">README.rst</tt>, line 44)</p>
-<p>Literal block expected; none found.</p>
-</div>
-</li>
-</ul>
-<p>~$ pip install django-dynamic-link</p>
-<ul class="simple">
-<li>With pip you can also uninstall it:</li>
-</ul>
-<pre class="literal-block">
-:~$ pip uninstall django-dynamic-link
-</pre>
-</blockquote>
 <p><em>Other possibilities</em></p>
 <blockquote>
 <ul class="simple">
 </blockquote>
 <p><strong>test your installation</strong></p>
 <blockquote>
-Go to console and type:</blockquote>
+<p>Go to console and type:</p>
 <pre class="literal-block">
 :~$ python
+</pre>
+<p>... than type:</p>
+<pre class="doctest-block">
 &gt;&gt;&gt; import dynamicLink
 &gt;&gt;&gt; dynamicLink.VERSION
 </pre>
+</blockquote>
 </div>
 <div class="section" id="setup">
 <h1>Setup</h1>
 <dt>Make sure that:</dt>
 <dd><ol class="first last arabic simple">
 <li>'django.middleware.locale.LocaleMiddleware', is in your MIDDLEWARE_CLASSES.</li>
-<li>'django.contrib.redirects.middleware.RedirectFallbackMiddleware', is in your MIDDLEWARE_CLASSES.</li>
-<li>'django.contrib.redirects', is added to your INSTALLED_APPS.</li>
-<li>Your Admin is enabled ('django.contrib.admin', is in your INSTALLED_APPS.)</li>
+<li>Your Admin is enabled ('django.contrib.admin', is in your INSTALLED_APPS).</li>
+<li>'django.contrib.auth.context_processors.auth', (also for admin) is in TEMPLATE_CONTEXT_PROCESSORS.</li>
+<li>'django.core.context_processors.request', is in TEMPLATE_CONTEXT_PROCESSORS.</li>
 </ol>
 </dd>
 </dl>
 <li>Zero value for clicks means unlimited clicks.</li>
 <li>If a link never expires you can use it for click counting.</li>
 <li>Trough the action menu you can serve a site with several links.</li>
-<li>The filename from the created links are only for human readability. You can delete or change this filenames in any way you want.</li>
+<li>The filename from the created links are only for human readability. You can delete or change these filenames in any way you want.</li>
 </ul>
 </blockquote>
 </div>
 <p>djang-dynamic-links ships with an example proect.</p>
 <blockquote>
 <ol class="arabic simple">
-<li>First unpack the tar.gz</li>
-<li>Than move &quot;dynamicLink&quot; in to the &quot;example&quot; folder or install it (see install section).</li>
+<li>Install the package (see install section).</li>
 <li>Run &quot;python manage.py syncdb&quot; and &quot;python manage.py runserver&quot;.</li>
 <li>Open a Browser, go to: <a class="reference external" href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a></li>
 </ol>