Skip to content

Per-project documentation #52

@fluffynuts

Description

@fluffynuts

It would be great to spend some time on documenting individual projects, even if only briefly in a README.md in each project's folder. The natural knock-on for this would be to make the readme available in the nuget package via the nuspec options outlined at https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/, specifically:

<package>
    <metadata>
    ...
    <readme>docs\README.md</readme>
    ...
    </metadata>
    <files>
    ...
    <file src="..\README.md" target="docs\" />
    ...
    </files>
</package>

this would:

  • make it easier for someone not acquainted with the projects to use them
  • surface this documentation at nuget.org

Projects to consider (probably best candidates in bold):

  • PeanutButter.Async
  • PeanutButter.TestUtils.Async
  • PeanutButter.DatabaseHelpers
  • PeanutButter.DatabaseHelpers.Testability
  • PeanutButter.INI
  • PeanutButter.SimpleHTTPServer
  • PeanutButter.SimpleTcpServer
  • PeanutButter.TempDb
  • PeanutButter.TempDb.LocalDb
  • PeanutButter.TempDb.MySql.Connector
  • PeanutButter.TempDb.MySql.Data
  • PeanutButter.TempDb.SqlCe
  • PeanutButter.TempDb.Sqlite
  • PeanutButter.TempRedis
  • PeanutButter.RandomGenerators
  • PeanutButter.TestUtils.Entity
  • PeanutButter.TestUtils.Generic
  • PeanutButter.TestUtils.MVC
  • PeanutButter.TinyEventAggregator
  • PeanutButter.DuckTyping
  • PeanutButter.EasyArgs
  • PeanutButter.FileSystem
  • PeanutButter.FluentMigrator
  • PeanutButter.JObjectExtensions
  • PeanutButter.MVC
  • PeanutButter.NetUtils
  • PeanutButter.Utils
  • PeanutButter.Utils.Entity
  • PeanutButter.Utils.Windsor
  • PeanutButter.XmlUtils
  • PeanutButter.ServiceShell
  • PeanutButter.WindowsServiceManagement

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions