| Safe Haskell | None |
|---|---|
| Language | GHC2024 |
Language.Drasil.Code.Imperative.README.Core
Description
This module defines structures and functions for handling README files, which are used as auxiliary documentation files for the system.
Synopsis
- data ReadMeInfo = ReadMeInfo {
- langName :: LangAbbrev
- langVersion :: LangVers
- invalidOS :: Maybe String
- implementType :: ImplementationType
- extLibNV :: [(Name, Version)]
- extLibFP :: [FilePath]
- contributors :: [Contributor]
- configFP :: [RelativeFile]
- caseName :: CaseName
- examplePurpose :: ExamplePurpose
- exampleDescr :: ExampleDescr
- exampleMotivation :: ExampleMotivation
- exampleScope :: ExampleScope
- folderNum :: Int
- inputOutput :: (InFile, OutFile)
- makeReadMe :: ReadMeInfo -> Doc
Documentation
data ReadMeInfo Source #
Holds all information needed to create a README file.
Constructors
| ReadMeInfo | |
Fields
| |
makeReadMe :: ReadMeInfo -> Doc Source #
Generates a README file.