Update the default value of riece-url-regexp.
[riece] / doc / HACKING
index 882d835..a20e75d 100644 (file)
@@ -1,49 +1,43 @@
 -*- mode: text -*-
 
-This document is for Riece developers.  The information necessary for
-Riece development is explained (i.e. its development process and the
-internals.)
+This document is for Riece developers or those who are interested in
+becoming a developer.
 
-* Development process
-
-** Bug report
+The main topics explained here are the development process and the
+internals.
 
-You can create a template of a bug report by clicking the "bug" button
-in a toolbar, or M-x riece-submit-bug-report.  It is necessary to set
-riece-debug to t before preparing a bug report.
+* Development process
 
-** Debug output
+** Reporting bugs
 
-If the riece-debug variable is set to t, Riece begins to collect
-debugging information in *Debug* buffer.  Interactions with IRC
-servers are stored in " *IRC*<IRC-server-name>" buffers.  Note that
-these buffers have names starting with a whitespace character (" ").
+If you find a bug, please file it at
+https://savannah.nongnu.org/bugs/?group=riece
 
-** Joining the development
+** Contributing code
 
-To join the development, send us a patch or an add-on.
+If you write an add-on or a patch, send it to us.  If it is useful, we
+may incorporate it into the development source code.
 
-** CVS
+** Getting the development source code
 
-Development of Riece uses CVS.  Latest developing version is available
-at CVS.  Please note that the version from CVS may NOT be reliable,
-and you can only use it at your own risk.  We may ignore bug reports
-for that version.  The instruction to access the CVS server is below.
+The development of Riece uses Git.  The latest development version is
+available from git.sv.gnu.org.  
 
-(1) logging in to anonymous CVS server
+NOTE: If you are a beginning user, who just wants to try the "newer"
+version, stick on the latest released version.  Pointless complaints
+about development versions are unwelcome to us.
 
-    cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
-    CVS password: [CR] # NULL string
+The instructions to obtain and build the source from Git are below.
 
-(2) checkout modules
+(1) checkout modules
 
-    cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece
+    git clone git://git.sv.gnu.org/riece.git
 
-(3) generate configure script
+(2) generate configure script
 
     autoreconf -f -i -v
 
-You will need newer version of GNU Automake.
+Note that "autoreconf" is not "autoconf".
 
 * Internals
 
@@ -390,6 +384,9 @@ functions.
 - <module-name>-insinuate
   Called on initialization of this module.
 
+- <module-name>-uninstall (optional)
+  Called on uninstallation of this module.
+
 - <module-name>-enable (optional)
   Called when this add-on is enabled.