tools/ein: rewrite README

modules/tools/ein/README.org

@@ -1,20 +1,34 @@
-#+TITLE: :tools ein
+#+TITLE:   tools/ein
-
+#+DATE:    April 11, 2018
-* EIN -- Emacs IPython Notebook
+#+SINCE:   v2.0
-
+#+STARTUP: inlineimages
-Tool to work with Jupyter notebooks within emacs.
 
 * Table of Contents :TOC:
-- [[EIN -- Emacs IPython Notebook][EIN -- Emacs IPython Notebook]]
+- [[Description][Description]]
-- [[Install][Install]]
+  - [[Module Flags][Module Flags]]
-- [[Usage][Usage]]
+  - [[Plugins][Plugins]]
+- [[Prerequisites][Prerequisites]]
+- [[Features][Features]]
+  - [[Interaction with a Jupyter server][Interaction with a Jupyter server]]
 - [[Configuration][Configuration]]
+  - [[Setting the default location of your notebooks][Setting the default location of your notebooks]]
 
-* Install
+* Description
-Add =:tool ein= to your ~doom!~ call in your private ~init.el~.
+Adds Jupyter notebook integration into emacs.
 
-* Usage
+** Module Flags
+This module provides no flags.
+
+** Plugins
++ [[https://github.com/millejoh/emacs-ipython-notebook][ein]]
+
+* Prerequisites
+This module has no prereqisites.
+
+* Features
+** Interaction with a Jupyter server
 Three functions are available to start EIN:
+
  1. ~ein:jupyter-server-start~ --- Start a jupyter server within emacs
  2. ~ein:notebooklist-login~ --- Login to an existing jupyter server
  3. ~ein:notebooklist-open~ --- Open the list of jupyter notebooks
@@ -25,15 +39,15 @@ When ~ein:jupyter-server-start~ is called, after successfully finishing,
 ~ein:notebooklist-login~ and ~ein:notebooklist-open~ will be automatically
 called.
 
-When in the ~Notebook List~ buffer, the key ~o~ calls ~ace-link~ to speed up the
+When in the ~Notebook List~ buffer, the key =o= calls ~ace-link~ to speed up the
 process of selecting links in the buffer.
 
-If ~company-mode~ is enabled as a module, ~company-ein~ will be used for
+If ~company-mode~ is enabled as a module, ~company-ein~ will handle completion.
-completion purposes.
 
 * Configuration
-Specify the default directory where EIN searches for notebooks using:
+** Setting the default location of your notebooks
-
+Change ~+ein-notebook-dir~ to tell ein where to find your Jupityr notebooks.
-~(set! :ein-notebook-dir "~/my-notebooks")~
-
 
+#+BEGIN_SRC emacs-lisp
+(setq +ein-notebook-dir "~/my-notebooks")
+#+END_SRC