diff --git a/README.md b/README.md index 6cec1ca94..1b247a340 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,30 @@ [![PyPI](https://img.shields.io/pypi/v/retrolab.svg)](https://pypi.org/project/retrolab) [![conda-forge](https://img.shields.io/conda/vn/conda-forge/retrolab.svg)](https://anaconda.org/conda-forge/retrolab) -`RetroLab` (also known as _JupyterLab Retro_, previously called _JupyterLab Classic_) is a [JupyterLab](https://github.com/jupyterlab/jupyterlab) distribution with a retro look and feel. +[Introduction](#introduction) | [Try it](#try-it-online-in-your-browser) | +[Installation](#install) | [Usage](#usage) | [Tour](#tour) | +[Contributing](#contributing) | [Motivation](#motivation) | +[vs Other Jupyter Frontends](#relation-to-other-jupyter-frontends) | +[Community Guidelines](#community-guidelines-and-code-of-conduct) + +## Introduction + +`RetroLab` (also known as _JupyterLab Retro_, previously called _JupyterLab +Classic_) is a [JupyterLab](https://github.com/jupyterlab/jupyterlab) +distribution with a retro look and feel, more similar to the classic +[Jupyter notebook](https://github.com/jupyter/notebook). ![retrolab](https://user-images.githubusercontent.com/591645/138552467-ed2d96ff-1ea3-496c-bc7b-660d009c1459.png) ## Try it online in your browser -It is possible to try RetroLab on Binder without installing anything using the following link: +It is possible to try RetroLab on the web in Binder without installing +anything: - -Try it on Binder - +- A tour of the current release: + [![Binder Tour](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gist/jtpio/4a6a34da66b32249e28df718ec30e4d7/master?urlpath=/retro/notebooks/tour.ipynb) +- The current state of this development repository: + [![Binder Main](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/retrolab/main?urlpath=retro/tree) ## Install