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

Mostly line wraps, and a small grammar fix to writing/documentation.

Browse Source
This commit is contained in:
george
2014-06-17 12:41:00 -06:00
parent 2e9ae2152f
commit c3b3e766f9
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+11 -11
View File
@@ -8,22 +8,21 @@ both you and others a lot of time.
Project Documentation
---------------------
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
lines explaining the purpose of the project or the library (without
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.
A :file:`README` file at the root directory should give general information
to both users and maintainers of a project. It should be raw text or
written in some very easy to read markup, such as :ref:`reStructuredText-ref`
or Markdown. It should contain a few lines explaining the purpose of the
project or library (without 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 :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 :file:`README`
file.
A :file:`LICENSE` file should *always* be present and specify the license under which the
software is made available to the public.
A :file:`LICENSE` file should *always* be present and specify the license
under which the software is made available to the public.
A :file:`TODO` file or a ``TODO`` section in :file:`README` should list the
planned development for the code.
@@ -158,7 +157,8 @@ Pycco_
.. _Docco: http://jashkenas.github.com/docco
Ronn_
Ronn builds unix manuals. It converts human readable textfiles to roff for terminal display, and also to HTML for the web.
Ronn builds unix manuals. It converts human readable textfiles to roff
for terminal display, and also to HTML for the web.
.. _Ronn: https://github.com/rtomayko/ronn