next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
SimpleDoc > packageTemplate

packageTemplate -- a template for a package

Synopsis

Description

This routine returns a barebones package template that you can use to start writing a package.
i1 : print packageTemplate "WonderfulModules"

newPackage(
        "WonderfulModules",
        Version => "0.1", 
        Date => "",
        Authors => {{Name => "", 
                  Email => "", 
                  HomePage => ""}},
        Headline => "",
        DebuggingMode => true
        )

export {}

-- Code here

beginDocumentation()

doc ///
Key
  WonderfulModules
Headline
Description
  Text
  Example
Caveat
SeeAlso
///

doc ///
Key
Headline
Usage
Inputs
Outputs
Consequences
Description
  Text
  Example
  Code
  Pre
Caveat
SeeAlso
///

TEST ///
-- test code and assertions here
-- may have as many TEST sections as needed
///

See also

Ways to use packageTemplate :