www/index.html

   1 <html>
   2 <head>
   3 </head>
   4 <body>
   5
   6 <p>SCons is a next-generation,
   7 cross-platform build tool
   8 this to fit your project.  You dont need to anwser all these questions
   9 or follow this exact format, but we do like to see this kind of
  10 information before we approve projects for public viewing.
  11 </p>
  12
  13 <p>Until your project is approved, only you can view it and work on
  14 it.
  15 </p>
  16
  17 <ul>
  18 <li>This index.html will be used if and only if you have the "Use
  19 Project Home Page" option checked on the "Adminster Project" page
  20 (click the "Admin" tab).</li>
  21
  22 <li>To edit this file, check out your project via CVS and edit www/index.html.
  23
  24 <li>You can 'cvs add' and commit other files under the project's "www"
  25 directory and they will published to your project web site.</li>
  26
  27 <li>Also, consider starting a thread in the "dev" mailing list to get
  28 thes discussion started.  A good one is an "introduction" thread where
  29 people post messages about themselves and their interest in the
  30 project.</li>
  31
  32 <li>You can add a "Highlights:" line to the top of all web pages by adding a file www/project_highlights.html </li>
  33 </ul>
  34
  35
  36 <h3>Mission</h3>
  37
  38 <p>What is the goal of this project?
  39 </p>
  40
  41 <p>What is the scope of this project?
  42 </p>
  43
  44 <p>For example:</p>
  45
  46 <ul>
  47 <li>Develop just enough functionality to scratch a particular itch</li>
  48 <li>Build a tool just like XYZ, but less broken</li>
  49 <li>Build the best XYZ-tool ever!</li>
  50 </ul>
  51
  52
  53 <p>What are high-level features you are sure to build?
  54 </p>
  55 <ul>
  56
  57 <li>What would you write on a billboard about your project? Users
  58 might only look for a few seconds.</li>
  59
  60 <li>Use the issue tracker to track features and enhancement
  61 requests. It is not just for bugs, pre-populate it with feature
  62 descriptions so that potential contributors know what you would like them
  63 to work on.</li>
  64 </ul>
  65
  66 <p>What are the high-level assumptions or ground rules for the project?
  67 </p>
  68
  69 <p>For example:
  70 </p>
  71
  72 <ul>
  73 <li> we will use programming language X on operating system Y for now.
  74
  75 <li>We will, or will not, consider certain functional areas like
  76 internationalization, high security, concurrency, etc.  The list of
  77 functional areas will depend on what you are trying to do.
  78
  79 <li>Try to keep this part short.
  80 </ul>
  81
  82
  83 <h3>Related resources</h3>
  84
  85 <ul>
  86 <li>Link to other stuff that you know about.  It will help you
  87 research requirements and provide a useful resource to potential
  88 contributors.</li>
  89
  90 <li>Why reinvent the wheel? What is better about this wheel?  Is there
  91 any existing project that you can partner with or reuse?</li>
  92
  93 <li>Where would you go to try to find potential contibutors?</li>
  94 </ul>
  95
  96 </body>
  97 </html>