ReadMeFile class

A README.md file is typically the first item a visitor will see when visiting your package on https://pub.dev or visiting your code on https://github.com.

A README.md file typically include information on:

• What the project does
• Why the project is useful
• How to use it
• other relevant high level information

A README.mdt is a TemplateFile that is used by the DocumentationBuilder to create or override the README.md file in the root of your dart project. The README.mdt file is stored in the doc/template folders in the root of the project

Inheritance

• Object
• TemplateFile
• MarkdownTemplateFile
• ReadMeFile

Constructors

ReadMeFile()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited