kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mark up files & directories

Browse Source
This commit is contained in:
Zearin
2014-04-11 11:26:37 -04:00
parent a604dd1095
commit cc7b19356e
13 changed files with 69 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+6 -6
View File
@@ -8,7 +8,7 @@ both you and others a lot of time.
Project Documentation
---------------------
A ``README`` file at the root directory should give general
A :file:`README` file at the root directory should give general
information to the users and the maintainers. It should be raw text or
written in some very easy to read markup, such as
:ref:`reStructuredText-ref` and Markdown. It should contain a few
@@ -17,18 +17,18 @@ assuming the user knows anything about the project), the url of the
main source for the software, and some basic credit information. This
file is the main entry point for readers of the code.
An ``INSTALL`` file is less necessary with python. The installation
An :file:`INSTALL` file is less necessary with python. The installation
instructions are often reduced to one command, such as ``pip install
module`` or ``python setup.py install`` and added to the ``README``
module`` or ``python setup.py install`` and added to the :file:`README`
file.
A ``LICENSE`` file should *always* be present and specify the license under which the
A :file:`LICENSE` file should *always* be present and specify the license under which the
software is made available to the public.
A ``TODO`` file or a ``TODO`` section in ``README`` should list the
A :file:`TODO` file or a ``TODO`` section in :file:`README` should list the
planned development for the code.
A ``CHANGELOG`` file or section in ``README`` should compile a short
A :file:`CHANGELOG` file or section in :file:`README` should compile a short
overview of the changes in the code base for the latest versions.
Project Publication