updated
authorPekka Riikonen <priikone@silcnet.org>
Sat, 22 Jul 2000 18:37:45 +0000 (18:37 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sat, 22 Jul 2000 18:37:45 +0000 (18:37 +0000)
README.CVS

index ad487ee3ffa6bdf69bd6751196252862de8ac1b7..4d534eb2e13f0f9f4090edea3c2cfd678b53159d 100644 (file)
@@ -1,31 +1,65 @@
-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 even these web pages. The CVS access and hosting for the
+public SILC CVS mirror is kindly provided by SourceForge.  The actual CVS
+repository that is used in the development resides in silc.pspt.fi and is
+mirrored by SourceForge.
 
-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. The CVS repository is mirrored
+hourly by the SourceForge.
 
-       export CVSROOT=:pserver:silccvs@silc.pspt.fi:/silc
 
+Browsing the Source Tree
+========================
 
-Checkout of SILC source tree, and to bemore specific, SILC trunk, give,
+If you want to browse the source tree using web browser before checking
+out the tree with CVS use following link:
 
-       cvs co silc
+http://cvs.sourceforge.net/cgi-bin/cvsweb.cgi/?cvsroot=silc
 
-or
 
-       cvs -d :pserver:silccvs@silc.pspt.fi:/silc co 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.
+
+For those who are using sh/ksh/bash the check out is done as follows:
+
+export CVSROOT=:pserver:anonymous@cvs.silc.sourceforge.net:/cvsroot/silc
+cvs login
+cvs co silc
 
+For those who are using csh/tcsh the check out is done as follows:
 
-CVS will ask password.  The password for anonymous (read access) CVS is
+setenv CVSROOT :pserver:anonymous@cvs.silc.sourceforge.net:/cvsroot/silc
+cvs login
+cvs co silc
 
-       CVS password: silccvs
+If you don't want to set $CVSROOT environment variable you can set the
+path to the cvs as command line options:
 
+cvs -d:pserver:anonymous@cvs.silc.sourceforge.net:/cvsroot/silc login
+cvs -d:pserver:anonymous@cvs.silc.sourceforge.net:/cvsroot/silc co silc
 
-CVS currently does not have branches, thus this checkouts the trunk.
+What ever method you decide to use, after you have done cvs login you will
+be prompted for password:
+
+       CVS password:
+
+There is no password so you can press enter when prompted.
+
+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 1.5 Mb but will grow in the future.
 
 
 What SILC Source Tree Includes
@@ -79,13 +113,13 @@ configuration and compilation.  To compile the source three, give,
        ./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 +127,21 @@ 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 -f configfile 2>log
+       ./silcd -f configfile 2>log
 
 
 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,24 +154,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
-
-Note there are other files in the sources that has version information 
-as well that currently needs to be updated by hand.
-
-
-$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.