changeset 83208:e318dfc2edc6

README updates. git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-248
author Karoly Lorentey <lorentey@elte.hu>
date Mon, 20 Sep 2004 13:59:19 +0000
parents 4df500c93e1d
children c06211125947
files README.multi-tty
diffstat 1 files changed, 28 insertions(+), 15 deletions(-) [+]
line wrap: on
line diff
--- a/README.multi-tty	Mon Sep 20 09:41:18 2004 +0000
+++ b/README.multi-tty	Mon Sep 20 13:59:19 2004 +0000
@@ -58,16 +58,15 @@
 development trunk to occur sometime during next year (2005), after the
 merge of the Unicode branch.
 
-Please let me know if you find any bugs in this branch.
+Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD.  Please let me
+know if you succeed or fail to use it on other platforms---I'll have a
+few tricky test cases for you.
 
 Known problems:
 
 	* Mac, Windows and DOS support is broken, probably doesn't
 	  even compile -- this will be solved later.
 
-	* Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD.
-
-
 HOW TO GET THE BRANCH
 ---------------------
 
@@ -75,14 +74,14 @@
 
 Retrieving the latest version of the branch:
 
-	tla register-archive lorentey@elte.hu--2004 http://lorentey.hu/arch/2004/
+	tla register-archive http://lorentey.hu/arch/2004/
 	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>
 
 This incantation uses my private archive mirror that is hosted on a
 relatively low-bandwidth site; if you are outside Hungary, you will
 probably want to you use the Arch supermirror instead:
 
-	tla register-archive lorentey@elte.hu--2004 http://mirrors.gnuarch.org/lorentey@elte.hu--2004/
+	tla register-archive http://mirrors.gnuarch.org/lorentey@elte.hu--2004/
 	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>
 
 (I use a recent tla development snapshot, but any of the released
@@ -105,19 +104,27 @@
 	http://lorentey.hu/project/emacs.html
 
 
-HOW TO COMPILE
---------------
+COMPILATION
+-----------
 
 The multi-tty branch is compiled the same way as Emacs itself:
 
+	make maintainer-clean  # (If you have compiled Emacs before)
+
 	./configure <your favourite options>
 	make bootstrap
 	make install
 
-HOW TO TEST IT
---------------
+If you have strange compilation errors, they may be caused by old
+*.elc files that are left over from an earlier bootstrap.  The `make
+maintainer-clean' target deletes them, so it is a good idea to run
+that before reporting a bug.  (Emacs requires a clean recompilation
+after certain kinds of source code changes.)
 
-To try out the multi-tty branch start up the Emacs server with the
+TESTING
+-------
+
+To test the multi-tty branch, start up the Emacs server with the
 following commands:
 
 	emacs
@@ -141,7 +148,8 @@
 
 This is work in progress, and probably full of bugs.  You should
 always run emacs from gdb, so that you'll have a live instance to
-debug if something goes wrong.  Please send me your bug reports.
+debug if something goes wrong.  Please send me
+(multi-tty@lists.fnord.hu) your bug reports.
 
 TIPS & TRICKS
 -------------
@@ -262,9 +270,9 @@
 THANKS
 ------
 
-The following is an (incomplete) list of people who have contributed
-to the project by testing, submitting patches, bug reports, and
-suggestions.  Thanks!
+The following is a (sadly incomplete) list of people who have
+contributed to the project by testing, submitting patches, bug
+reports, and suggestions.  Thanks!
 
 ARISAWA Akihiro <ari at mbf dot ocn dot ne dot jp>
 Han Boetes <han at mijncomputer dot nl>
@@ -294,6 +302,11 @@
 
 See arch logs.
 
+* * *
+
+(The rest of this file consists of my development notes and as such it
+is probably not very interesting for anyone else.)
+
 THINGS TO DO
 ------------