Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Per-project documentation #52

Open
fluffynuts opened this issue Jan 20, 2022 · 0 comments
Open

Per-project documentation #52

fluffynuts opened this issue Jan 20, 2022 · 0 comments

Comments

@fluffynuts
Copy link
Owner

fluffynuts commented Jan 20, 2022

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant