SPKG.txt

= Sage Notebook =

== Description ==

The Sage Notebook is a web-based graphical user interface for
mathematical software.

== License ==

GPLv2+

== SPKG Maintainers ==

 * William Stein
 * Tim Dumol
 * Mitesh Patel

== Upstream Contact ==

 * William Stein
 * Homepage: http://nb.sagemath.org/

== Dependencies ==

 * Python >= 2.6
 * jinja2 >= 2.1.1
 * Twisted >= 8.2
 * zope.testbrowser >= 3.8.1 (included)
 * Sphinx >= 0.6.3 (pretty docstrings)

== Special Update / Build Instructions ==

 * To release a new spkg, check that

   * All changes are committed.
   * .hgignore and MANIFEST.in are current.
   * The patch queue is clear.
   * The notebook runs.
   * The doctests pass: sage -t -sagenb
   * Test for ability to install without internet connection.
     Any dependencies that must be downloaded can be added in ./spkg-dist and inserted
     in setup.py. Dependencies of dependencies need not be put in setup.py, but
     need to be put in ./spkg-dist.
   * The Selenium tests pass (optional, for now).

   Then,

   * Update the version in setup.py and commit this change.
   * Run spkg-dist.
   * Install and test the new spkg: sage -f dist/sagenb-*.spkg

   Contact a maintainer about pushing updates to the public Mercurial
   repository.

 * Stylesheets (CSS): see sass/readme.txt.

== Changelog ==

 * For an accurate log of changes, run "hg log" in src/sagenb.