From b251f0b6b91c22a7e12259d18631e4b6905e16a6 Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Sun, 27 Aug 2017 19:55:39 -0700 Subject: [PATCH] Add pip install instructions to README. (#869) --- README.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index bf7e2a89a..187da6edc 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,23 @@ Ray Ray is a flexible, high-performance distributed execution framework. -View the `documentation`_. +Installation +------------ -.. _`documentation`: http://ray.readthedocs.io/en/latest/index.html +- Ray can be installed on Linux and Mac with ``pip install ray``. +- To build Ray from source, see the instructions for `Ubuntu`_ and `Mac`_. + +.. _`Ubuntu`: http://ray.readthedocs.io/en/latest/install-on-ubuntu.html +.. _`Mac`: http://ray.readthedocs.io/en/latest/install-on-macosx.html + + +More Information +---------------- + +- `Documentation`_ +- `Blog`_ +- `HotOS paper`_ + +.. _`Documentation`: http://ray.readthedocs.io/en/latest/index.html +.. _`Blog`: https://ray-project.github.io/ray/ +.. _`HotOS paper`: https://arxiv.org/abs/1703.03924