#6495 add first lines to test linking

twosigma · Feb 26, 2018 · f785c5f · f785c5f
1 parent cc152cd
commit f785c5f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,15 @@ The Java unit tests are run with every build. See [test/README.md] for how to ru
 docker run -p 8888:8888 beakerx/beakerx
 ```
 
+## Overview
+
+BeakerX is a collection of kernels and extensions for Jupyter.
+The code is organized as follows:
+
+* [beakerx](beakerx) The Python package.
+* [doc](doc) Documentation consisting of notebooks.  [StartHere.ipynb](StartHere.ipynb) at the top level links to these.
+
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).