summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJarrod Millman <jarrod.millman@gmail.com>2017-09-30 18:27:27 -0700
committerJarrod Millman <jarrod.millman@gmail.com>2017-09-30 21:17:36 -0700
commit5386f8d5c7804425339a661f4a413081d4847a8c (patch)
tree70ec48c6ab9df3df384dcbcaeb7bcf548eefe671 /README.md
parentd05fd3032cccabf5ed18840b43513a73499af5d6 (diff)
downloadnumpy-5386f8d5c7804425339a661f4a413081d4847a8c.tar.gz
DOC: Clean up README
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 13 insertions, 24 deletions
diff --git a/README.md b/README.md
index 2b9540dd5..3f0d075b5 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,23 @@
-<div align="center">
- <img src="http://www.numpy.org/_static/numpy_logo.png"><br>
-</div>
-
-[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)
-
------------------
-| **`Travis CI Status`** |
-|-------------------|
-[![Travis](https://api.travis-ci.org/numpy/numpy.svg?branch=master)](https://travis-ci.org/numpy/numpy)|
+# <img alt="NumPy" src="branding/icons/numpylogo.svg" height="60">
+[![Travis](https://api.travis-ci.org/numpy/numpy.svg?branch=master)](https://travis-ci.org/numpy/numpy)
NumPy is the fundamental package needed for scientific computing with Python.
-This package contains:
- * a powerful N-dimensional array object
- * sophisticated (broadcasting) functions
- * tools for integrating C/C++ and Fortran code
- * useful linear algebra, Fourier transform, and random number capabilities.
+- **Website (including documentation):** http://www.numpy.org
+- **Mailing list:** https://mail.python.org/mailman/listinfo/numpy-discussion
+- **Source:** https://github.com/numpy/numpy
+- **Bug reports:** https://github.com/numpy/numpy/issues
-It derives from the old Numeric code base and can be used as a replacement for Numeric. It also adds the features introduced by numarray and can be used to replace numarray.
+It provides:
-More information can be found at the website:
+- a powerful N-dimensional array object
+- sophisticated (broadcasting) functions
+- tools for integrating C/C++ and Fortran code
+- useful linear algebra, Fourier transform, and random number capabilities
-* http://www.numpy.org
-
-After installation, tests can be run (if ``nose`` is installed) with:
+If ``nose`` is installed, tests can be run after installation with:
python -c 'import numpy; numpy.test()'
-The most current development version is always available from our
-git repository:
-
-* http://github.com/numpy/numpy
+[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)