next up previous contents
Next: General Naming Conventions Up: Software Development and Coding Previous: Document layout and conventions   Contents

Directory Structure

A new dedicated VIS account forms the root of the software repository and development tree. All active VIS projects shall implement this structure.


Table: VIS development tree
The VIS Development Tree
vis/     VIS source code repository and main development directory
  bin/   Binaries of VIS specific applications and standard demos
  build/   Templates for makefiles, scripts and other common tools
  cvsroot/   Root directory of the CVS source code repository
  demos/   Working demos for presentation purposes
  doc/   Documentation
  include/   Include files for VIS libraries
  lib/   VIS libraries
  log/   Log files documenting the latest software builds
  papers/   Collection of published papers
  presentations/   Collection of presentations and presentation templates
  projects/   Projects directory tree
  templates/   Standard templates for source and header files
  www/   Internal web documents
       
projects/     Projects directory tree
  name/   Project name
    bin/ Project binaries
    src/ Project source code directory
    obj/ Project object directory
    doc/ Project specific documentation
    lib/ Project libraries
    include/ Project include files
    qa/ Project test code and scripts
       
templates/     Standard VIS style templates
  template.cxx   Template for C++ source files
  template.h   Template for C++ header files
  project.html   Template for project descriptions
       
doc/     This document
       
build/     Templates for makefiles, scripts and tools
  Commondefs   Common definitions for make
  Makefile   Generic VIS makefile




All newly created projects have to provide the projects directory structure. Otherwise the build script will not work properly. Furthermore, each project must have a project.html file in its doc directory. These files will be used to automatically update the HTML page describing the project purpose and implementation state. File access permissions will be used to determine which files should be accessible publicly through the VIS web-page.


next up previous contents
Next: General Naming Conventions Up: Software Development and Coding Previous: Document layout and conventions   Contents
Falko Kuester 2001-08-24