Commits

hideki nara  committed c251f9a

Updates

  • Participants
  • Parent commits d2df8c2

Comments (0)

Files changed (7)

File INSTALL

-========================================================================
-**djpostal** Installation Instructions
-========================================================================
-
-This section contains information about 
-how to download and install **djpostal ** in your system. 
-It also contains brief instructions about how
-to build the included documentation.
-
-Requirements
-============
-
-Detailed information about the minimum supported Python modules
- that may be required in order to run this software is shown below:
-
-.. literalinclude:: ../requirements.txt
-
-This information exists in the ``requirements.txt`` file 
-inside the ** djpostal ** distribution package. 
-If ``pip`` is used to install this software,
-then all these dependencies will also be installed, 
-if they are not already installed in your system.
-
-
-Soruce
-========
-
-Got to Bitubucket.org.
-
-URL is https://bitbucket.org/hdknr/djpostal
-
-
-Install
-=======
-
-To install **djpostal** from soruce code, use the provided installation script::
-
-    python setup.py install
-
-
-Or it is also possible to install this application directly from
-the `source code repository`_ using ``pip``::
-
-    pip install -e hg+https://bitbucket.org/hdknr/djpostal
-
-The above command will install the latest development release of **djpostal**.
-
-
-How to build the documentation
-==============================
-
-This project's documentation is located in source form under the ``docs``
-directory. In order to convert the documentation to a format that is
-easy to read and navigate you need the ``sphinx`` package.
-
-You can install ``sphinx`` using ``pip``::
-
-    pip install sphinx
-
-Or ``easy_install``::
-
-    easy_install sphinx
-
-Once ``sphinx`` is installed, change to the ``docs`` directory, open a shell
-and run the following command::
-
-    make html
-
-This will build a HTML version of the documentation. You can read the
-documentation by opening the following file in any web browser::
-
-    docs/_build/html/index.html
+========================================================================
+**djpostal** Installation Instructions
+========================================================================
+
+This section contains information about 
+how to download and install **djpostal** in your system. 
+It also contains brief instructions about how
+to build the included documentation.
+
+Requirements
+============
+
+Detailed information about the minimum supported Python modules
+ that may be required in order to run this software is shown below:
+
+.. literalinclude:: ../requirements.txt
+
+This information exists in the ``requirements.txt`` file 
+inside the ** djpostal ** distribution package. 
+If ``pip`` is used to install this software,
+then all these dependencies will also be installed, 
+if they are not already installed in your system.
+
+
+Soruce
+========
+
+Got to Bitubucket.org.
+
+URL is https://bitbucket.org/hdknr/djpostal
+
+
+Install
+=======
+
+To install **djpostal** from soruce code, use the provided installation script::
+
+    python setup.py install
+
+
+Or it is also possible to install this application directly from
+the `source code repository`_ using ``pip``::
+
+    pip install -e git+https://bitbucket.org/hdknr/djpostal
+
+The above command will install the latest development release of **djpostal**.
+
+
+How to build the documentation
+==============================
+
+This project's documentation is located in source form under the ``docs``
+directory. In order to convert the documentation to a format that is
+easy to read and navigate you need the ``sphinx`` package.
+
+You can install ``sphinx`` using ``pip``::
+
+    pip install sphinx
+
+Or ``easy_install``::
+
+    easy_install sphinx
+
+Once ``sphinx`` is installed, change to the ``docs`` directory, open a shell
+and run the following command::
+
+    make html
+
+This will build a HTML version of the documentation. You can read the
+documentation by opening the following file in any web browser::
+
+    docs/_build/html/index.html
 
 The views and conclusions contained in the software and documentation are those of the
 authors and should not be interpreted as representing official policies, either expressed
-or implied, of Hideki Nara.
+or implied, of Hideki Nara.

File README

-djpostal
-========================================================================
-
-under development.
+djpostal
+========================================================================
+
+under development.

File requirements.txt

 Sphinx
+pykf
         maintainer_email = 'gmail [at] hdknr.com',
         url = 'https://bitbucket.org/hdknr/djpostal',
         description = 'djpostal is a postal address manager.',
-        long_description = read('README'),
+        long_description = read('README.rst'),
         download_url = 'https://bitbucket.org/hdknr/djpostal',
         platforms=['any'],
         classifiers = [