Browse Source

More READMEs

Ian Rose 7 years ago
parent
commit
a78b273e6b

+ 3 - 0
packages/coreutils/README.md

@@ -1 +1,4 @@
 # @jupyterlab/coreutils
+
+A JupyterLab package which provides utility functions and data structures that are widely used across many
+of the `@jupyterlab` packages. This includes (among other things) functions for manipulating paths, urls, strings, lists, and maps.

+ 2 - 0
packages/csvviewer-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/csvviewer-extension
+
+An extension for JupyterLab which provides an entry point for the [@jupyterlab/csvviewer](../csvviewer) package.

+ 3 - 0
packages/csvviewer/README.md

@@ -1 +1,4 @@
 # @jupyterlab/csvviewer
+
+A JupyterLab package that provides a viewer for CSV files,
+based upon the [@phosphor/datagrid](https://github.com/phosphorjs/phosphor/tree/master/packages/datagrid) package.

+ 2 - 0
packages/faq-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/faq-extension
+
+A JupyterLab extension which provides a frequently-asked-questions window for the application.

+ 2 - 0
packages/filebrowser-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/filebrowser-extension
+
+An extension for JupyterLab which provides an entry point, commands, and keyboard shortcuts for the [@jupyterlab/filebrowser](../filebrowser) package.

+ 4 - 0
packages/filebrowser/README.md

@@ -1 +1,5 @@
 # @jupyterlab/filebrowser
+
+A JupyterLab package which provides a file browser to the application.
+Document operations (such as opening, closing, renaming and moving),
+are delegated to the [document manager](../docmanager).

+ 2 - 0
packages/fileeditor-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/fileeditor-extension
+
+An extension for JupyterLab which provides an entry point, commands, and keyboard shortcuts for the [@jupyterlab/fileeditor](../fileeditor) package.

+ 4 - 0
packages/fileeditor/README.md

@@ -1 +1,5 @@
 # @jupyterlab/fileeditor
+
+A JupyterLab package which provides a text editor. The default text editor wraps
+a [codemirror](../codemirror) instance, but others may be substituted by
+implementing the [@jupyterlab/codeeditor](../codeeditor) interface.

+ 2 - 0
packages/help-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/help-extension
+
+A JupyterLab extension that provides a help menu, including links to documentation.

+ 2 - 0
packages/imageviewer-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/imageviewer-extension
+
+An extension for JupyterLab which provides an entry point, commands, and keyboard shortcuts for the [@jupyterlab/imageviewer](../imageviewer) package.

+ 2 - 0
packages/imageviewer/README.md

@@ -1 +1,3 @@
 # @jupyterlab/imageviewer
+
+A JupyterLab package which provides an image viewer.

+ 4 - 0
packages/inspector-extension/README.md

@@ -1 +1,5 @@
 # @jupyterlab/inspector-extension
+
+An extension for JupyterLab which provides an entry point, commands, and keyboard shortcuts for the [@jupyterlab/inspector](../inspector) package.
+
+It is used in both the [@jupyterlab/notebook](../notebook) and [@jupyterlab/console](../console) packages.

+ 2 - 0
packages/inspector/README.md

@@ -1 +1,3 @@
 # @jupyterlab/inspector
+
+A JupyterLab package which provides a variable inspector.

+ 2 - 0
packages/launcher-extension/README.md

@@ -1 +1,3 @@
 # @jupyterlab/launcher-extension
+
+An extension for JupyterLab which provides an entry point for the [@jupyterlab/launcher](../launcher) package.

+ 5 - 0
packages/launcher/README.md

@@ -1 +1,6 @@
 # @jupyterlab/launcher
+
+A JupyterLab package that provides a launcher for various activities,
+including notebooks, consoles, text editors, and terminals.
+
+JupyterLab extensions may register themselves with the launcher in order to show up as an activity when the application starts.