Patch 2 for issue 117

INSTALL.rst

@@ -0,0 +1,43 @@
+=============================================
+Installation of the Sage notebook from github
+=============================================
+The current development version of the Sage notebook is present in github.
+Since this development version is not yet merged into the Sage
+distribution, one needs to follow a couple of additional steps to have
+a working development version of the Sage notebook.
+
+Installation Steps
+------------------
+The steps one needs to follow are outlined below.
+
+#. First install the latest development version of Sage from the
+   `sagemath`_ website.
+#. Next, follow the directions in `ticket 13121`_ to upgrade your notebook
+   to version 0.10.1 (or the latest version).
+#. Create a fork of the `sagenb`_ git repository on the github website. To
+   create the fork, go to `sagenb`_ and click on "Fork" on the upper right
+   corner of the webpage.
+#. Clone your fork on to your local machine as follows. Note that the
+   ``SAGE_ROOT`` variable below corresponds to the directory in which the
+   Sage distribution is present, and ``username`` is your login name in
+   github::
+
+    $ cd SAGE_ROOT/devel
+    $ git clone [email protected]:username/sagenb.git sagenb-github
+    $ rm sagenb
+    $ ln -s sagenb-github sagenb
+    $ cd sagenb
+    $ ../../sage --python setup.py develop
+
+#. You can also add the `sagenb`_ git repository as a remote branch called
+   ``upstream``::
+
+    $ git remote add upstream [email protected]:sagemath/sagenb
+    $ git fetch upstream
+
+#. You are now all set to work with the development version of the Sage
+   notebook!
+
+.. _sagemath: http://sagemath.org/download-latest.html
+.. _`ticket 13121`: http://trac.sagemath.org/sage_trac/ticket/13121
+.. _sagenb: https://github.com/sagemath/sagenb

MANIFEST.in

@@ -1,12 +1,8 @@
-recursive-include sagenb *
-recursive-include sass *
-recursive-include util *
+graft sagenb
+graft sass
+graft util
 prune sass/src/.sass-cache
-recursive-include flask_version *
-include *.txt Makefile MANIFEST.in .hgignore .hgtags sdist spkg-dist SPKG.txt go .gitignore README.rst
-recursive-include .hg *
-prune .hg/git
-prune .hg/patches
-exclude .hg/git-*
-exclude .hg/hgrc
+graft flask_version
+include *.txt MANIFEST.in .gitignore dist.sh README.rst
+prune .git
 global-exclude *.pyc *.pyo *.orig *.rej *~ \#* *\# *.sassc *.scssc *.DS_Store

README.rst

@@ -35,16 +35,15 @@ data is stored in that directory.
 SSL support
 -----------
 
-SSL is required for OpenID and accessing HTTPS from the Sage shell. Your
-Sage install should usually support SSL out of the box, but if you
-compiled it from source on a machine without the libssl headers, it may
-not. You can check for SSL support by running ``import ssl`` in the Sage
-console. If you get an error, then do the following.
-
-1. Install the libssl headers on your system. On Debian-based systems,
-   one way to do this is to run ``sudo apt-get install libssl-dev``.
-2. Recompile Sage's internal Python interpreter by running ``sage -f
-   python``.
+SSL is required for OpenID and HTTPS support in the notebook. OpenID
+only requires Python's built-in SSL support, whereas HTTPS support also
+requires the Python library pyOpenSSL. In order to ensure that these are
+installed, please follow the instructions in Sage's own README file
+(look for the section about SSL). If you don't intend to use OpenID for
+user logins, or HTTPS for connecting to the server, you can safely
+ignore this section. In particular, if you're installing a copy of Sage
+for your personal use only, you probably won't need OpenID or HTTPS
+support in the notebook.
 
 
 
@@ -53,3 +52,76 @@ Development
 
 See the Sage Developer's guide, part of the Sage documentation, for
 instructions.
+
+Miscellaneous Release Instructions
+----------------------------------
+
+The following advice for release managers of sagenb is taken from the
+old SPKG.txt file that was sitting around. Most of it is probably
+outdated, but here it is anyway. It is modified slightly to cause it to
+make sense in some cases.
+
+    To cut a new release of sagenb, make sure that:
+
+    * All changes are committed.
+
+    * ``.gitignore`` and ``MANIFEST.in`` are current.
+
+    * The notebook runs.
+
+    * The doctests pass: ``sage -t --sagenb``
+
+    * The notebook will be possible to install from the new SPKG without
+      an internet connection.
+
+      * Any dependencies that must be downloaded can be added in
+        ``util/fetch_deps.py`` and inserted in ``setup.py``.
+        Dependencies of dependencies need not be put in ``setup.py``,
+        but need to be put in ``util/fetch_deps.py`` (until we can make
+        it smarter).
+
+    * The Selenium tests pass (optional, for now).
+
+    * The localization file ``sagenb.pot`` is up-to-date.
+
+      * Run ``pybabel extract -F /path/to/babel.cfg /path/to/project -o
+        /path/to/sagenb.po`` (get pybabel with ``easy_install
+        pybabel``).
+
+      * Copy the headers from the existing ``sagenb.pot``.
+
+      * Replace ``sagenb.pot`` with ``sagenb.po``.
+
+      * Then, update the version in ``setup.py`` and commit this change.
+
+      * Run ``dist.sh``, optionally with a ``-g`` argument to package
+        the git repo too.
+
+      * Copy the newly generated ``dist/`` directory from the sagenb
+        repo to the SPKG's root directory and rename it ``src/``
+        , replacing the ``src/`` directory that is currently there
+
+      * Pack up the SPKG with ``sage --pkg --no-compress`` (because
+        everything in ``src/`` is already compressed)
+
+      * Install and test the new spkg: ``sage -f sagenb-*.spkg``
+
+      * Don't forget to push all changes in the sagenb repo to github.
+
+    Stylesheets (CSS): see ``sass/readme.txt``.
+
+    To add a locale to an existing install:
+
+    * Create a new locale, or download one from
+      http://wiki.sagemath.org/i18n . To create a new locale:
+
+      * Edit and save a copy of ``sagenb.pot`` using your favorite text
+        editor or POEdit (http://poedit.net)
+
+      * (Recommended) Post the new locale to
+        http://wiki.sagemath.org/i18n
+
+    * Compile your copy via ``msgfmt sagenb.pot -o sagenb.mo``
+
+    * Copy ``sagenb.mo`` to ``sagenb/locale/xx_YY/LC_MESSAGES/``, where
+      xx_YY is a locale code (en_US, pt_BR, en_UK, etc.)