ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/UserCode/README
Revision: 1.4
Committed: Fri Jun 18 06:40:21 2010 UTC (14 years, 10 months ago) by elmer
Branch: MAIN
CVS Tags: JP-2011-02-03, V00-01-00, JP-2011-01-16-a, JP-2011-01-15-a, JP-2011-01-11-a, JP-2011-01-10-c, JP-2011-01-10-b, JP-2011-01-10-a, JP-2011-01-04-a, JP-2010-12-20-a, JP-2010-12-15-b, JP-2010-12-15-a, JP-2010-12-11-a, JP-2010-12-09-a, JP-2010-12-08-a, JP-2010-12-06-a, JP-2010-12-05-b, JP-2010-12-05-a, JP-2010-12-01-a, JP-2010-11-30-a, JP-2010-11-29-a, JP-2010-11-25-a, JP-2010-11-22-a, JP-2010-11-20-c, JP-2010-11-20-a, JP-2010-11-19-b, JP-2010-11-19-a, JP-2010-11-18-a, JP-2010-11-10-b, JP-2010-11-10-a, JP-2010-11-09-a, JP-2010-10-20-a, JP-2010-10-14-a, JP-2010-10-13-a, JP-2010-10-12-a, JP-2010-10-05-a, JP-2010-10-04-a, JP-2010-09-30-a, V00-00-16, V00-00-15, V00-00-14, V00-00-13, V0-00-12, V00-00-11
Changes since 1.3: +0 -0 lines
Log Message:
Put back the README (using revision 1.2). It appears to have been removed
recently by user "lbarbone", presumably accidentally while cleaning up
other things.

File Contents

# User Rev Content
1 elmer 1.1
2 lbarbone 1.3 $Id: README,v 1.2 2006/09/21 12:37:19 elmer Exp $
3 elmer 1.1
4     Creating a user area in the CMSSW repository
5     --------------------------------------------
6    
7     There is an area called "UserCode" in the CMSSW repository where you can
8     create yourself a package to store your code and cfg files, for example:
9    
10     UserCode/PElmer
11    
12     Note that this area is primarily intended for "user" code which will never
13     go into CMSSW software releases. If you intend for your code to go into
14     CMSSW releases, you should probably just request a normal package with the
15     normal procedure via the Tag Collector.
16    
17     To create such a user CVS area for yourself, do the following:
18    
19     1) Choose a packagename for yourself. Typically this should be your
20     name (e.g. with some capitalization as above, or your CERN unix
21     username, etc.) so that it is semi-obvious whose package it is.
22    
23     2) Then create your package (here for an example "JohnDoe" user):
24    
25     (set your CVSROOT to point to the CMSSW CVS repository)
26     ('cd' to some temporary area)
27     cvs co UserCode/README
28     mkdir UserCode/JohnDoe
29 elmer 1.2 cd UserCode
30     cvs add JohnDoe
31 elmer 1.1
32     In general it is advisable to structure it like a normal CMSSW package,
33     i.e. with the same subdirectory structure. To do this, you can do:
34    
35 elmer 1.2 mkdir JohnDoe/src JohnDoe/interface
36     cvs add JohnDoe/src JohnDoe/interface
37     mkdir JohnDoe/data JohnDoe/test
38     cvs add JohnDoe/data JohnDoe/test
39 elmer 1.1
40     If you do not think you need some of these subdirectories at the
41     moment, you simply do not 'mkdir' and 'cvs add' them.
42    
43     3) Then you can 'cd' into the "src" area of some scram working/developer
44     area and do:
45    
46     cvs co UserCode/JohnDoe
47    
48     and begin to add your code and cfg files to the subdirectories. If you
49     need a BuildFile, you can copy an example from a normal CMSSW package
50     and edit it to serve your purposes.
51    
52     *********************************************************************
53     ** Please note that you should _not_ commit files to the UserCode **
54     ** directory itself, but only in your equivalent of the "JohnDoe" **
55     ** sub-directory.... **
56     *********************************************************************
57