From 13552fa76358661c2fb4be8749bb6a31d87ca178 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Sun, 14 Apr 2019 20:17:34 +0200 Subject: [PATCH] Rearange README to move documentation and contributing up --- README.rst | 61 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index 03ac32148..5238fca0f 100644 --- a/README.rst +++ b/README.rst @@ -28,8 +28,8 @@ What is BinderHub? ------------------ -**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image using a -GitHub repository, then ``CONNECT`` with JupyterHub, allowing you to create a +**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image from a +Git repository, then ``CONNECT`` with JupyterHub, allowing you to create a public IP address that allows users to interact with the code and environment within a live JupyterHub instance. You can select a specific branch name, commit, or tag to serve. @@ -43,8 +43,41 @@ BinderHub ties together: - `Repo2Docker `_ which generates a Docker image using a Git repository hosted online. -BinderHub is created using Python, kubernetes, tornado, and traitlets. As such, -it should be a familiar technical foundation for Jupyter developers. +BinderHub is built with Python, kubernetes, tornado, npm, webpack, and sphinx. + + +Documentation +------------- + +For more information about the architecture, use, and setup of BinderHub, see +`the BinderHub documentation `_. + + +Contributing +------------ + +To contribute to the BinderHub project you can work on: + +* `answering questions others have `_, +* writing documentation, +* designing the user interface, or +* writing code. + +To see how to build the documentation, edit the user interface or modify the +code see `the contribution guide `_. + + +Installation +------------ + +**BinderHub** is based on Python 3, it's currently only hosted on GitHub +(pip release soon). However, it can be installed using ``pip``:: + + pip install git+https://github.com/jupyterhub/binderhub + +See `the BinderHub documentation `_ for +a detailed guide on setting up your own BinderHub server. + Why BinderHub? -------------- @@ -53,6 +86,7 @@ Collections of Jupyter notebooks are becoming more common in scientific research and data science. The ability to serve these collections on demand enhances the usefulness of these notebooks. + Who is BinderHub for? --------------------- * **Users** who want to easily interact with computational environments that @@ -62,25 +96,6 @@ Who is BinderHub for? * **Deployers** who want to create their own BinderHub to run on whatever hardware they choose. -Installation ------------- - -**BinderHub** is based on Python 3, it's currently only hosted on GitHub (pip release soon). -However, it can be installed using ``pip``:: - - pip install git+https://github.com/jupyterhub/binderhub - -See `the BinderHub documentation `_ for a detailed guide on setting -up your own BinderHub server. - -**Local development**: To run BinderHub locally in order to make contributions to the codebase, -see `the contribution guide `_. - -Documentation -------------- - -For more information about the architecture, use, and setup of BinderHub, see -`the BinderHub documentation `_. License -------