summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoranatoly techtonik <techtonik@gmail.com>2015-12-26 13:50:41 +0300
committeranatoly techtonik <techtonik@gmail.com>2015-12-26 13:50:41 +0300
commit1301507a4a7679a2aaa80b82f4b99af9b84bfa85 (patch)
tree3cc6720ec4d388e192b607563a5f405ac0845f38 /README.md
parent76f2870e2f9c821b704ead165e13e173282f0aa9 (diff)
downloadnumpy-1301507a4a7679a2aaa80b82f4b99af9b84bfa85.tar.gz
Update and rename README.txt to README.md
Add Travis build status on the main GitHub page. Prettified markup
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..e63d2718e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+[![Travis](https://img.shields.io/travis/numpy/numpy.svg)](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.
+
+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.
+
+More information can be found at the website:
+
+* http://www.numpy.org
+
+After installation, tests can be run with:
+
+ python -c 'import numpy; numpy.test()'
+
+The most current development version is always available from our
+git repository:
+
+* http://github.com/numpy/numpy