README_RFORGE

   1                         R-Forge SVN README
   2
   3
   4 (See "http://download.r-forge.r-project.org/manuals/R-Forge_Manual.pdf"
   5        for detailed information on registering a new project.
   6
   7 1. Introduction
   8 -----------------------------------------------------------------------
   9 R is free software distributed under a GNU-style copyleft. R-Forge is
  10 a service for R users and package developers providing certain tools
  11 for collaborative source code management.
  12
  13 2. The directory you're in
  14 -----------------------------------------------------------------------
  15 This is the repository of your project. It contains two important
  16 pre-defined directories namely 'www' and 'pkg'. They must not be
  17 deleted otherwise R-Forge's core functionality will not be available
  18 (daily check and build of your package or project websites).
  19 These two directories are standardized and therefore are going to be
  20 described in this README. The rest of your repository can be used as
  21 you like.
  22
  23 3. 'pkg' directory
  24 -----------------------------------------------------------------------
  25 Typically this directory contains the R package with the usual
  26 DESCRIPTION and R/, man/, data/ directories etc (see 'Writing R
  27 Extension' for more details). In the future it will also be possible to
  28 have multiple packages managed by a control file, however currently
  29 this feature is still under development).
  30
  31 Furthermore, this directory will be checked out daily, the package is
  32 checked and if it passes this procedure it is build and made available at
  33 http://R-Forge.R-project.org/src/contrib/ (as source tar.gz and win32
  34 .zip). It should be possible to install the package via
  35 install.packages("foo",url="R-Forge.R-project.org") within R
  36 then.
  37
  38 4. 'www' directory
  39 -----------------------------------------------------------------------
  40 This directory contains your project homepage which is available at
  41 http://<projectname>.R-Forge.R-project.org.
  42 Note that it will be checked out daily, so please take
  43 into consideration that it will not be available right after you
  44 commit your changes or updates.
  45
  46 5. Help
  47 -----------------------------------------------------------------------
  48 If you need help don't hesitate to contact us
  49 (R-Forge@R-project.org)