updates.
[silc.git] / README.CVS
index ecd40d5e28d12ecb1050446a6bf1c0a621a5c8e8..9db7980e332f52118d2fcc87bd76c793aa776d48 100644 (file)
@@ -1,31 +1,52 @@
-This document describes how to compile the SILC source tree after checkout
-from the CVS.  This README.CVS file will appear only in the checkout
-source tree and not in any public distribution.
+Anonymous CVS Access
+====================
 
-Howto Checkout Source Tree
-==========================
+Anonymous CVS access is now available to SILC CVS repository. The
+repository includes everything related to SILC project; source codes,
+documentation and web pages.
 
-Be sure to set the CVSROOT environment variable first or use -d option
-of CVS.  I suggest setting CVSROOT environment variable.
+Also note that this is the closest to real time development you can get
+thus you cannot expect that the source tree would work or even compile.
+While it is our intention that the trunk would always at least compile
+there might be situations when it will not.
 
-       export CVSROOT=:pserver:silccvs@silc.pspt.fi:/silc
 
+Howto Checkout The Source Tree
+==============================
+
+The repository can be checked out by using anonymous pserver with CVS.
+There are no password restrictions in the SILC anonymous CVS repository.
 
-Checkout of SILC source tree, and to bemore specific, SILC trunk, give,
+For those who are using sh/ksh/bash the check out is done as follows:
 
-       cvs co silc
+export CVSROOT=:pserver:silc@silc.pspt.fi:/storage/silc/CVS
+cvs login
+cvs co silc
 
-or
+For those who are using csh/tcsh the check out is done as follows:
 
-       cvs -d :pserver:silccvs@silc.pspt.fi:/silc co silc
+setenv CVSROOT :pserver:silc@silc.pspt.fi:/storage/silc/CVS
+cvs login
+cvs co silc
 
+If you don't want to set $CVSROOT environment variable you can set the
+path to the cvs as command line options:
 
-CVS will ask password.  The password for anonymous (read access) CVS is
+cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS login
+cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS co silc
 
-       CVS password: silccvs
+What ever method you decide to use, after you have done cvs login you will
+be prompted for password:
 
+       CVS password: silc
 
-CVS currently does not have branches, thus this checkouts the trunk.
+Type the password "silc" and press Enter.
+
+The actual SILC source tree is checked out using the cvs co silc command,
+described above. This command will fetch the source tree and save it into
+directory named silc. SILC CVS repository currently does not have any
+branches thus this will check out the trunk. The size of the trunk is
+currently about 8 Mb but will grow in the future.
 
 
 What SILC Source Tree Includes
@@ -73,19 +94,19 @@ Howto Compile SILC Source Tree
 ==============================
 
 After checkout from CVS the SILC source tree must be prepared for 
-configuration and compilation.  To compile the source three, give,
+configuration and compilation.  To compile the source tree, give,
 
        ./prepare
        ./configure --enable-debug
        make
 
-
 The ./prepare script is included in to the source tree and it never
 appears in public distribution.  The script prepares the source tree
 by creating configuration scripts and Makefiles.  The prepare must be
-run every time you make some changes to configuration scripts.
+run every time you make some changes to configuration scripts (however,
+making changes to Makefile.am's does not require running ./prepare).
 
-As a developer you should read the ./configure scripts help by
+As a developer you should read the ./configure script's help by
 giving ./configure --help and study all of its different options.  Also,
 you should configure the script with --enable-debug option as it
 compiles SILC with -g (debugging) option and it enables the 
@@ -93,21 +114,23 @@ SILC_LOG_DEBUG* scripts.  Warning is due here:  The debugging produced
 by both cilent and server is very heavy, thus it is common to test
 the programs as follows:
 
-       ./silc -f <config file> 2>silc.log
-       ./silcd -f <config file> 2>silcd.log
+       ./silc -d -f configfile 2>log
+       ./silcd -d -f configfile 2>log
+
+Do not give the -d options if you do not want to dump the debugging.
 
 
 Howto Clean SILC Source Tree
 ============================
 
-To entirely clear the source tree to the state after it was checkedout
+To entirely clear the source tree to the state after it was checked out
 from CVS, give,
 
        ./prepare-clean
 
-
 This calls `make distclean' plus removes automatically generated files
-by hand.  It also removes *.log files.
+by hand.  It also removes *.log files. However, it will not remove
+any other files you might have created.
 
 
 Makefiles and configuration files
@@ -120,32 +143,8 @@ are plenty of examples what they should look like.  If you change
 Makefile.am during development you don't have to run ./prepare, just
 run normal make.
 
-Configuration files the files that ./prepare automatically generates
+Configuration files are the files that ./prepare automatically generates
 and what will be included into public distribution.  ./prepare creates
-for example the ./configure script that is not commited to the CVS and
-must not be commited.  `configure.in' is the file that developers must
-edit to change ./configure script.  After changing one must run 
-./prepare.
-
-
-Creating Distribution
-=====================
-
-The version of the distribution is currently always set in the configure.in
-file.  The actual distribution is created by simply giving,
-
-       make dist
-
-
-Information About CVS Repository
-================================
-
-SILC CVS repository resides in silc.pspt.fi (193.166.51.47) in a 2 Gb
-SCSI harddrive.  The repository is backuped every morning at 06:00 EEST.
-The entire repository is backuped and the backup is distributed to at
-least two independent machines and the backup is recorded into tapes,
-as well.  There are always week's of backups in hand in case they are
-needed.  Every week the "lastweek's" backups are removed and "this weeks"
-backups are saved.
-
-$Id$
+for example the ./configure script that is not commited to the CVS.
+`configure.in' is the file that developers must edit to change ./configure
+script.  After changing one must run  ./prepare.