@@ -8,22 +8,21 @@ both you and others a lot of time.
88Project Documentation
99---------------------
1010
11- A :file: `README ` file at the root directory should give general
12- information to the users and the maintainers. It should be raw text or
13- written in some very easy to read markup, such as
14- :ref: `reStructuredText-ref ` and Markdown. It should contain a few
15- lines explaining the purpose of the project or the library (without
16- assuming the user knows anything about the project), the url of the
17- main source for the software, and some basic credit information. This
18- file is the main entry point for readers of the code.
11+ A :file: `README ` file at the root directory should give general information
12+ to both users and maintainers of a project. It should be raw text or
13+ written in some very easy to read markup, such as :ref: `reStructuredText-ref `
14+ or Markdown. It should contain a few lines explaining the purpose of the
15+ project or library (without assuming the user knows anything about the
16+ project), the url of the main source for the software, and some basic credit
17+ information. This file is the main entry point for readers of the code.
1918
2019An :file: `INSTALL ` file is less necessary with Python. The installation
2120instructions are often reduced to one command, such as ``pip install
2221module `` or ``python setup.py install `` and added to the :file: `README `
2322file.
2423
25- A :file: `LICENSE ` file should *always * be present and specify the license under which the
26- software is made available to the public.
24+ A :file: `LICENSE ` file should *always * be present and specify the license
25+ under which the software is made available to the public.
2726
2827A :file: `TODO ` file or a ``TODO `` section in :file: `README ` should list the
2928planned development for the code.
@@ -158,7 +157,8 @@ Pycco_
158157.. _Docco : http://jashkenas.github.com/docco
159158
160159Ronn _
161- Ronn builds unix manuals. It converts human readable textfiles to roff for terminal display, and also to HTML for the web.
160+ Ronn builds unix manuals. It converts human readable textfiles to roff
161+ for terminal display, and also to HTML for the web.
162162
163163.. _Ronn : https://github.com/rtomayko/ronn
164164
0 commit comments