General project naming

Abstract

You can use this document to normalize your project name

Common project subdirectory names

  • src/ (source code)
  • lib/ (library source code)
  • include/ (common c and c++ header files)
  • doc/ (documentation)
  • arch/ (specific to a given processor architecture)
  • os/ (operating system-specific code)
  • tools/ (tools used during the build process)
  • conf/ (buildtime configuration information)
  • etc/ (runtime configuration information)
  • bin/ (binary files and shell scripts)

Common file names

  • README (project overview)
  • MANIFEST (list of project files with brief explanations)
  • INSTALL (installation instructions)
  • LICENSE or Copying (license information)
  • TODO (wish list for future extensions)
  • NEWS (documentation on user-visible changes)
  • ChangeLog or Changes (code change summary)
  • configure (platform configuration script)
  • config.h (platform configuration definitions)
  • Makefile (build specification)
documents/misc/general_project_naming.txt · 上一次變更: 2008/02/14 18:35 由 kilroy
CC Attribution-Noncommercial-Share Alike 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0