SCM

SCM Repository

[trajectory-sim] Annotation of /README
ViewVC logotype

Annotation of /README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

1 : stefan7th 1 R-Forge SVN README
2 :    
3 :     This file explains the repository structure of your project. A more
4 :     detailed guide to R-Forge is available by
5 :     Theußl and Zeileis (2010) [1] and the R-Forge Administration and
6 :     Development Team (2009) [2].
7 :    
8 :     1. Introduction
9 :     -----------------------------------------------------------------------
10 :     R is free software distributed under a GNU-style copyleft. R-Forge is
11 :     a central platform for the development of R packages, R-related
12 :     software and further projects. Among many other web-based features it
13 :     provides facilities for collaborative source code management via
14 :     Subversion (SVN) [3].
15 :    
16 :     2. The directory you're in
17 :     -----------------------------------------------------------------------
18 :     This is the repository of your project. It contains two important
19 :     pre-defined directories namely 'pkg' and 'www'. These directories must
20 :     not be deleted otherwise R-Forge's core functionality will not be
21 :     available (i.e., daily checking and building of your package or the
22 :     project websites).
23 :     'pkg' and 'www' are standardized and therefore are going to be
24 :     described in this README. The rest of your repository can be used as
25 :     you like.
26 :    
27 :     3. 'pkg' directory
28 :     -----------------------------------------------------------------------
29 :     To make use of the package building and checking feature the package
30 :     source code has to be put into the 'pkg' directory of your repository
31 :     (i.e., 'pkg/DESCRIPTION', 'pkg/R', 'pkg/man', etc.) or, alternatively,
32 :     a subdirectory of 'pkg'. The latter structure allows for having more
33 :     than one package in a single project, e.g., if a project consists of
34 :     the packages foo and bar then the source code will be located in
35 :     'pkg/foo' and 'pkg/bar', respectively.
36 :    
37 :     R-Forge automatically examines the 'pkg' directory of every repository
38 :     and builds the package sources as well as the package binaries on a
39 :     daily basis for Mac OS X and Windows (if applicable). The package builds
40 :     are provided in the 'R Packages' tab for download or can be installed
41 :     directly in R from a CRAN-style repository using
42 :     'install.packages("foo", repos="http://R-Forge.R-project.org")'.
43 :     Furthermore, in the 'R Packages' tab developers can examine logs
44 :     generated on different platforms by the build and check process.
45 :    
46 :     4. 'www' directory
47 :     -----------------------------------------------------------------------
48 :     Developers may present their project on a subdomain of R-Forge, e.g.,
49 :     'http://foo.R-Forge.R-project.org', or via a link to an external
50 :     website.
51 :    
52 :     This directory contains the project homepage which gets updated hourly
53 :     on R-Forge, so please take into consideration that it will not be
54 :     available right after you commit your changes or additions.
55 :    
56 :     5. Help
57 :     -----------------------------------------------------------------------
58 :     If you need help don't hesitate to submit a support request at
59 :     https://r-forge.r-project.org/tracker/?func=add&group_id=34&atid=194,
60 :     search the forum
61 :     https://r-forge.r-project.org/forum/forum.php?forum_id=78&group_id=34,
62 :     or contact us at R-Forge@R-project.org.
63 :    
64 :     6. References
65 :     -----------------------------------------------------------------------
66 :    
67 :     [1] Stefan Theußl and Achim Zeileis. Collaborative software development
68 :     using R-Forge. The R Journal, 1(1):9-14, May 2009. URL
69 :     http://journal.r-project.org/2009-1/RJournal_2009-1_Theussl+Zeileis.pdf
70 :    
71 :     [2] R-Forge Administration and Development Team. RForge User’s Manual,
72 :     2008. URL http://download.R-Forge.R-project.org/R-Forge.pdf
73 :    
74 :     [3] C. M. Pilato, B. Collins-Sussman, and B. W. Fitzpatrick. Version
75 :     Control with Subversion. O’Reilly, 2004. Full book available online at
76 :     http://svnbook.red-bean.com/

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge