New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

General structure #1

Open

arokem opened this issue May 28, 2015 · 1 comment

Contributor

arokem commented May 28, 2015

The README file currently has the following sections (in this order):

Module code
Data
Testing (nosetests)
Documentation (sphinx)
Installation (setup.py)
Continuous integration (travis)
Distribution (PyPI and travis)
Licensing
Scripts

And finally:

How to use the repo

Is this a good structure? Any elements missing? Or too much?

billhowe commented May 29, 2015

This may be redundant, but does a "Quick Start" section make sense?

On Thu, May 28, 2015 at 2:56 PM, Ariel Rokem [email protected]
wrote:

The README file currently has the following sections (in this order):

Module code

Data

Testing (nosetests)

Documentation (sphinx)

Installation (setup.py)

Continuous integration (travis)

Distribution (PyPI and travis)

Licensing

Scripts

And finally:

How to use the repo

Is this a good structure? Any elements missing? Or too much?

—
Reply to this email directly or view it on GitHub
#1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment