Skip to content

Improve scaffolded readme content

username-removed-710918 requested to merge improve-scaffolding-readmes into master

Description

Added useful primer info to each readme in the template as well as for the project itself.

Related Issue

Resolves #10 (closed)

Motivation and Context

Nudges users into the pit of success, provides a sane default template for these documents for the users of scaffolded projects.

How Has This Been Tested?

Manually, locally.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Merge request reports