README: rewrite it, it was rather out-of-date

[sage.d.git] / README

diff --git a/README b/README
index 47ccc9f5516e63c4de76401db55e797a57cc0ba3..e7c660d0029df424944ba827c0785f23a9151100 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,11 @@
-My own personal library of Sage[1] code.
+My personal library of SageMath code
 
-It is intended to be loaded into every Sage session, or Python script
-which imports the Sage library. Sage loads ~/.sage/init.sage upon
-startup, so I've supplied a sample init.sage file which will load this
-code from ~/src/sage/.
+If you symlink it to ~/.sage/init.sage, the sample init.sage file will
+load this stuff into your session when Sage starts. It assumes that
+this repository lives at either ~/src/sage.d or ~/src/sage.d.git, but
+that's easy to change. More likely though you will want to copy/paste
+the relevant parts into your own personal (preexisting) init.sage.
 
-
-[1] http://www.sagemath.org/
+Newer versions of Sage don't load ~/.sage/init.sage during test mode,
+and all modules need to be imported explicitly. The test suite is
+therefore a little tricky to run; but "make check" should work.