Commits

catapela  committed 00bdb41

some changes in readme

  • Participants
  • Parent commits 7480f56

Comments (0)

Files changed (2)

 
         * 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:
+            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::
+
+            pip uninstall django-dynamic-link
+
+    *Oter Installation methodes*
+
+        1. You must download the package from pypi (stable) or bitbucket (development). Find a download location here_.
+
+.. _here: http://pypi.python.org/pypi/django-dynamic-link/#downloads
+
+        * Either copy the sources in your project root
+
+            2. Unpack your package.
+            3. Copy the folder "dynamic_link" in your project root.
+            4. Make sure all package dependences are fulfilled.
+
+        * Or use setup.py
+
+            2. Unpack your package.
+            3. Open a terminal and change to the folder which contains the setup.py and type:
 
             ::
 
-            :~$ pip install -e hg+https://bitbucket.org/catapela/django-dynamic-link/#egg=django-dynamic-link
-
-        * With pip you can also uninstall:
-
-        ::
-
-        :~$ 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
-
-        1. Download the file and unzip it.
-        2. Copy the folder in your project root.
-        3. 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:
-
-        ::
-
-        :~$ python setup.py install
+                python setup.py install
 
 **test your installation**
 
-    Go to console and type:
+    Go to console and type::
 
-    ::
+        python
 
-    :~$ python
-
-    ... than type:
+    ... then type::
     
-    >>> import dynamicLink
-    >>> dynamicLink.VERSION
+        >>> import dynamicLink
+        >>> dynamicLink.VERSION
+        >>> exit()
     
 =====
 Setup
         1.   from dynamicLink import presettings
         2.   (r'^\w+/%s/' % presettings.DYNAMIC_LINK_URL_BASE_COMPONENT, include('dynamicLink.urls')),
     
-    * Finally run:
+    * Finally run::
 
-    ::
-
-    :~$ python manage.py syncdb
-    :~$ python manage.py runserver
+        python manage.py syncdb
+        python manage.py runserver
 
 **Make it custom**
 
 
 djang-dynamic-links ships with an example proect.
 
-    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/
+    1. First you need the example project folder which is shipped within the package. See the "manual installation" section above to find out where to download it.
+    2. After you got the desired package install it (see install section).
+    3. Next you have to extract the example folder within the package to any location you want.
+    4. Open a terminal and change directory into the previous extracted example folder::
+
+        cd /path/to/example
+
+    5. After that run::
+
+        python manage.py syncdb
+        python manage.py runserver
+        
+    6. Finaly open a Browser and go to: http://127.0.0.1:8000/
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
 <title></title>
 <style type="text/css">
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
+:Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
 dl.docutils dd {
   margin-bottom: 0.5em }
 
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
 /* Uncomment (and remove this text!) to get bold-faced definition list terms
 dl.docutils dt {
   font-weight: bold }
 hr.docutils {
   width: 75% }
 
-img.align-left, .figure.align-left{
+img.align-left, .figure.align-left, object.align-left {
   clear: left ;
   float: left ;
   margin-right: 1em }
 
-img.align-right, .figure.align-right {
+img.align-right, .figure.align-right, object.align-right {
   clear: right ;
   float: right ;
   margin-left: 1em }
 
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
 .align-left {
   text-align: left }
 
 
 /* reset inner alignment in figures */
 div.align-right {
-  text-align: left }
+  text-align: inherit }
 
 /* div.align-center * { */
 /*   text-align: left } */
   margin-top: 0 ;
   font: inherit }
 
-pre.literal-block, pre.doctest-block {
+pre.literal-block, pre.doctest-block, pre.math {
   margin-left: 2em ;
   margin-right: 2em }
 
 <blockquote>
 <p>Type in your terminal:</p>
 <pre class="literal-block">
-:~$ pip install django-dynamic-link
+pip install django-dynamic-link
 </pre>
 </blockquote>
 </li>
 <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
+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:</p>
+<pre class="literal-block">
+pip uninstall django-dynamic-link
+</pre>
 </li>
 </ul>
+</blockquote>
+<p><em>Oter Installation methodes</em></p>
+<blockquote>
+<ol class="arabic simple">
+<li>You must download the package from pypi (stable) or bitbucket (development). Find a download location <a class="reference external" href="http://pypi.python.org/pypi/django-dynamic-link/#downloads">here</a>.</li>
+</ol>
+</blockquote>
+</blockquote>
+<blockquote>
+<ul>
+<li><p class="first">Either copy the sources in your project root</p>
+<blockquote>
+<ol class="arabic simple" start="2">
+<li>Unpack your package.</li>
+<li>Copy the folder &quot;dynamic_link&quot; in your project root.</li>
+<li>Make sure all package dependences are fulfilled.</li>
+</ol>
+</blockquote>
+</li>
+<li><p class="first">Or use setup.py</p>
+<blockquote>
+<ol class="arabic simple" start="2">
+<li>Unpack your package.</li>
+<li>Open a terminal and change to the folder which contains the setup.py and type:</li>
+</ol>
 <pre class="literal-block">
-:~$ pip uninstall django-dynamic-link
+python setup.py install
 </pre>
 </blockquote>
-<p><em>Manual Installation</em></p>
-<blockquote>
-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>.</blockquote>
-</blockquote>
-<blockquote>
-<blockquote>
-<ol class="arabic 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>
-</ol>
-</blockquote>
-<p><em>Other possibilities</em></p>
-<blockquote>
-<ul class="simple">
-<li>Open a terminal and change to the folder which contains the setup.py and then type:</li>
+</li>
 </ul>
-<pre class="literal-block">
-:~$ python setup.py install
-</pre>
-</blockquote>
 </blockquote>
 <p><strong>test your installation</strong></p>
 <blockquote>
 <p>Go to console and type:</p>
 <pre class="literal-block">
-:~$ python
+python
 </pre>
-<p>... than type:</p>
-<pre class="doctest-block">
+<p>... then type:</p>
+<pre class="literal-block">
 &gt;&gt;&gt; import dynamicLink
 &gt;&gt;&gt; dynamicLink.VERSION
+&gt;&gt;&gt; exit()
 </pre>
 </blockquote>
 </div>
 </dl>
 </li>
 <li><p class="first">Finally run:</p>
+<pre class="literal-block">
+python manage.py syncdb
+python manage.py runserver
+</pre>
 </li>
 </ul>
-<pre class="literal-block">
-:~$ python manage.py syncdb
-:~$ python manage.py runserver
-</pre>
 </blockquote>
 <p><strong>Make it custom</strong></p>
 <blockquote>
 <h1>Example project</h1>
 <p>djang-dynamic-links ships with an example proect.</p>
 <blockquote>
-<ol class="arabic simple">
-<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 class="arabic">
+<li><p class="first">First you need the example project folder which is shipped within the package. See the &quot;manual installation&quot; section above to find out where to download it.</p>
+</li>
+<li><p class="first">After you got the desired package install it (see install section).</p>
+</li>
+<li><p class="first">Next you have to extract the example folder within the package to any location you want.</p>
+</li>
+<li><p class="first">Open a terminal and change directory into the previous extracted example folder:</p>
+<pre class="literal-block">
+cd /path/to/example
+</pre>
+</li>
+<li><p class="first">After that run:</p>
+<pre class="literal-block">
+python manage.py syncdb
+python manage.py runserver
+</pre>
+</li>
+<li><p class="first">Finaly open a Browser and go to: <a class="reference external" href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a></p>
+</li>
 </ol>
 </blockquote>
 </div>