DotNetReportsEngine.ReadmeGeneration 1.0.0

dotnet add package DotNetReportsEngine.ReadmeGeneration --version 1.0.0                
NuGet\Install-Package DotNetReportsEngine.ReadmeGeneration -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DotNetReportsEngine.ReadmeGeneration" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetReportsEngine.ReadmeGeneration --version 1.0.0                
#r "nuget: DotNetReportsEngine.ReadmeGeneration, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DotNetReportsEngine.ReadmeGeneration as a Cake Addin
#addin nuget:?package=DotNetReportsEngine.ReadmeGeneration&version=1.0.0

// Install DotNetReportsEngine.ReadmeGeneration as a Cake Tool
#tool nuget:?package=DotNetReportsEngine.ReadmeGeneration&version=1.0.0                

Readme Generator

This Package Was Developed For Generating The Base Readme File To Improve The Speed Of Creating Standard Readme File and Make It Easy to All Developers To Creating Readme File Automatically . Enjoy It Logo

Authors

🚀 About Me

I MohammadReza Gholamizadeh. I`m Dotnet Software Developer That Always Try To Make All things Easy for Developing. Please Star the Project And Package to Cover.

Source Code Sample Code To Get Start MohammadReza Gholamizadeh GitHub Nuget

Licenses

Way To Register All Types That You Want To Introduce In Readme File

For This You Must To Use [ RenderInReadmeFile ] Attribute On Every Class That You Want To Introduce In Readme File. Like This :

namespace DotnetReportsEngine.SampleCode
{
    [RenderInReadmeFile]
    public class DotnetReportResourcesss
    {

Class And Method Implementation

Type : DotnetReportResourceExtensionMethods

DotnetReportResourceExtensionMethods Methods :

  • AddAssemblyOfType(generator)
Parameter Type Description
generator ReadmeGenerator ** Required.
  • AddAssembly(generator, assembly)
Parameter Type Description
generator ReadmeGenerator ** Required.
assembly Assembly ** Required. The Assembly That You Want To Add All Types In It To ReadMe File Generator.

This Method Add Assembly That You Want To Add All Types In It To ReadMe File Generator.

  • AddAssemblies(generator, assemblies)
Parameter Type Description
generator ReadmeGenerator ** Required.
assemblies IEnumerable<Assembly> ** Required. The Assembly That You Want To Add All Types In It To ReadMe File Generator.

This Method Add Assembly That You Want To Add All Types In It To ReadMe File Generator.

  • RenderAllAssembliesToText(generator)
Parameter Type Description
generator ReadmeGenerator ** Required.

This Method Generate Text Format For All Assembly That You Want To Add All Types In It To ReadMe File Generator.

  • SetProjectDetail(generator, title, description)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
description String ** Not Required.

This Method Generate Text Format For Project Detail That You Want To Add It To ReadMe File.

  • AddAcknowledgement(generator, acknowledgement)
Parameter Type Description
generator ReadmeGenerator ** Required.
acknowledgement Acknowledgement ** Required.

This Method Generate Text Format For Acknowledgement That You Want To Add It To ReadMe File.

  • AddAcknowledgement(generator, title, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.

This Method Generate Text Format For Acknowledgement That You Want To Add It To ReadMe File.

  • AddAcknowledgements(generator, acknowledgements)
Parameter Type Description
generator ReadmeGenerator ** Required.
acknowledgements IEnumerable<Acknowledgement> ** Required.

This Method Generate Text Format For Acknowledgement That You Want To Add It To ReadMe File.

  • AddAppendix(generator, appendix)
Parameter Type Description
generator ReadmeGenerator ** Required.
appendix Appendix ** Required.

This Method Generate Text Format For Appendix(Additional Information) That You Want To Add It To ReadMe File.

  • AddAppendix(generator, descriptionOrScript)
Parameter Type Description
generator ReadmeGenerator ** Required.
descriptionOrScript String ** Required.

This Method Generate Text Format For Appendix(Additional Information) That You Want To Add It To ReadMe File.

  • AddAppendixes(generator, appendixes)
Parameter Type Description
generator ReadmeGenerator ** Required.
appendixes IEnumerable<Appendix> ** Required.

This Method Generate Text Format For Appendix(Additional Information) That You Want To Add It To ReadMe File.

  • AddAuthor(generator, author)
Parameter Type Description
generator ReadmeGenerator ** Required.
author Author ** Required.

This Method Generate Text Format For Author Info That You Want To Add It To ReadMe File.

  • AddAuthor(generator, name, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
name String ** Required.
link String ** Not Required.

This Method Generate Text Format For Author Info That You Want To Add It To ReadMe File.

  • AddAuthors(generator, authors)
Parameter Type Description
generator ReadmeGenerator ** Required.
authors IEnumerable<Author> ** Required.

This Method Generate Text Format For Author Info That You Want To Add It To ReadMe File.

  • SetContributingDescription(generator, contributingDescription)
Parameter Type Description
generator ReadmeGenerator ** Required.
contributingDescription String ** Required.

This Method Generate Text Format For Contributing Info That You Want To Add It To ReadMe File.

  • AddColor(generator, colorTitle, hex)
Parameter Type Description
generator ReadmeGenerator ** Required.
colorTitle String ** Required.
hex String ** Required.

This Method Generate Text Format For Color Table That You Want To Add It To ReadMe File.

  • AddCcolor(generator, colorReference)
Parameter Type Description
generator ReadmeGenerator ** Required.
colorReference ColorReference ** Required.

This Method Generate Text Format For Color Table That You Want To Add It To ReadMe File.

  • AddColors(generator, colors)
Parameter Type Description
generator ReadmeGenerator ** Required.
colors IEnumerable<ColorReference> ** Required.

This Method Generate Text Format For Color Table That You Want To Add It To ReadMe File.

  • AddDemoLink(generator, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
link String ** Required.

This Method Generate Text Format For Demo That You Want To Add It To ReadMe File.

  • AddDemoLinks(generator, links)
Parameter Type Description
generator ReadmeGenerator ** Required.
links IEnumerable<String> ** Required.

This Method Generate Text Format For Demo That You Want To Add It To ReadMe File.

  • AddDeploymentDetail(generator, description, bashCommand)
Parameter Type Description
generator ReadmeGenerator ** Required.
description String ** Required.
bashCommand String[] ** Required.

This Method Generate Text Format For Deployment Detail That You Want To Add It To ReadMe File.

  • AddDeploymentDetails(generator, deploymentsDetails)
Parameter Type Description
generator ReadmeGenerator ** Required.
deploymentsDetails IEnumerable<Deployment> ** Required.

This Method Generate Text Format For Deployment Detail That You Want To Add It To ReadMe File.

  • AddFAQ(generator, question, answer)
Parameter Type Description
generator ReadmeGenerator ** Required.
question String ** Required.
answer String ** Required.

This Method Generate Text Format For Question and Answer That You Want To Add It To ReadMe File.

  • AddFAQs(generator, faqs)
Parameter Type Description
generator ReadmeGenerator ** Required.
faqs IEnumerable<FAQ> ** Required.

This Method Generate Text Format For Question and Answer That You Want To Add It To ReadMe File.

  • AddFeature(generator, feature)
Parameter Type Description
generator ReadmeGenerator ** Required.
feature String ** Required.

This Method Generate Text Format For Feature Detail That You Want To Add It To ReadMe File.

  • AddFeatures(generator, features)
Parameter Type Description
generator ReadmeGenerator ** Required.
features String[] ** Required.

This Method Generate Text Format For Feature Detail That You Want To Add It To ReadMe File.

  • SetFeedBackDetail(generator, feedBackDetail)
Parameter Type Description
generator ReadmeGenerator ** Required.
feedBackDetail String ** Required.

This Method Generate Text Format For FeedBack Info That You Want To Add It To ReadMe File.

  • SetGitHub_AboutMe(generator, gitHub_AboutMe)
Parameter Type Description
generator ReadmeGenerator ** Required.
gitHub_AboutMe String ** Required.

This Method Generate Text Format For Your Personal Description Abount YourSelf That You Want To Add It To ReadMe File.

  • SetGitHub_Introduction(generator, gitHub_Introduction)
Parameter Type Description
generator ReadmeGenerator ** Required.
gitHub_Introduction String ** Required.

This Method Generate Text Format For Your Personal Description Abount YourSelf That You Want To Add It To ReadMe File.

  • AddGitHub_Link(generator, gitHub_links)
Parameter Type Description
generator ReadmeGenerator ** Required.
gitHub_links GitHubLink ** Required.

This Method Generate Text Format For GitHub Link That You Want To Add It To ReadMe File.

  • AddGitHub_Link(generator, title, link, logoLinkType, logoLink)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.
logoLinkType LogoLinkType ** Required.
logoLink String ** Required.

This Method Generate Text Format For GitHub Link That You Want To Add It To ReadMe File.

  • AddGitHub_Link(generator, title, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.

This Method Generate Text Format For GitHub Link That You Want To Add It To ReadMe File.

  • AddGitHub_Links(generator, links)
Parameter Type Description
generator ReadmeGenerator ** Required.
links IEnumerable<GitHubLink> ** Required.

This Method Generate Text Format For GitHub Link That You Want To Add It To ReadMe File.

  • SetLicense(generator, license)
Parameter Type Description
generator ReadmeGenerator ** Required.
license License ** Required.

This Method Generate Text Format For License Info That You Want To Add It To ReadMe File.

  • SetLicense(generator, title, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.

This Method Generate Text Format For License Info That You Want To Add It To ReadMe File.

  • SetLogo(generator, logo)
Parameter Type Description
generator ReadmeGenerator ** Required.
logo Logo ** Required.

This Method Generate Text Format For Logo That You Want To Add It To ReadMe File.

  • SetLogo(generator, title, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.

This Method Generate Text Format For Logo That You Want To Add It To ReadMe File.

  • AddRelatedProject(generator, title, link)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
link String ** Required.

This Method Generate Text Format For Related Project Info That You Want To Add It To ReadMe File.

  • AddRelatedProject(generator, relatedProject)
Parameter Type Description
generator ReadmeGenerator ** Required.
relatedProject RelatedProject ** Required.

This Method Generate Text Format For Related Project Info That You Want To Add It To ReadMe File.

  • AddRelatedProjects(generator, relatedProjects)
Parameter Type Description
generator ReadmeGenerator ** Required.
relatedProjects IEnumerable<RelatedProject> ** Required.

This Method Generate Text Format For Related Project Info That You Want To Add It To ReadMe File.

  • AddCustomBashCommand(generator, title, bashCommands)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
bashCommands String[] ** Required.

This Method Generate Text Format For Custom Bash Command That You Want To Add It To ReadMe File.

  • AddCustomBashCommand(generator, bashcommand)
Parameter Type Description
generator ReadmeGenerator ** Required.
bashcommand CustomBashCommand ** Required.

This Method Generate Text Format For Custom Bash Command That You Want To Add It To ReadMe File.

  • AddCustomBashCommand(generator, bashCommands)
Parameter Type Description
generator ReadmeGenerator ** Required.
bashCommands IEnumerable<CustomBashCommand> ** Required.

This Method Generate Text Format For Custom Bash Command That You Want To Add It To ReadMe File.

  • AddCustomText(generator, title, description)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
description String ** Required.

This Method Generate Text Format For Custom Text That You Want To Add It To ReadMe File.

  • AddCustomText(generator, customText)
Parameter Type Description
generator ReadmeGenerator ** Required.
customText CustomText ** Required.

This Method Generate Text Format For Custom Text That You Want To Add It To ReadMe File.

  • AddCustomTexts(generator, customTexts)
Parameter Type Description
generator ReadmeGenerator ** Required.
customTexts IEnumerable<CustomText> ** Required.

This Method Generate Text Format For Custom Text That You Want To Add It To ReadMe File.

  • AddBadge(generator, title, badgeLink, redirectLink)
Parameter Type Description
generator ReadmeGenerator ** Required.
title String ** Required.
badgeLink String ** Required.
redirectLink String ** Required.

This Method Generate Text Format For Custom Badge That You Want To Add It To ReadMe File.

  • AddBadge(generator, badge)
Parameter Type Description
generator ReadmeGenerator ** Required.
badge Badge ** Required.

This Method Generate Text Format For Custom Badge That You Want To Add It To ReadMe File.

  • AddBadges(generator, badges)
Parameter Type Description
generator ReadmeGenerator ** Required.
badges IEnumerable<Badge> ** Required.

This Method Generate Text Format For Custom Badge That You Want To Add It To ReadMe File.

  • AddCustomCode(generator, language, CodeBody)
Parameter Type Description
generator ReadmeGenerator ** Required.
language String ** Required.
CodeBody String ** Required.

This Method Generate Text Format For Custom Code That You Want To Add It To ReadMe File.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DotNetReportsEngine.ReadmeGeneration:

Package Downloads
NetCalendar

This Package Is For Using The Different TypeOf DateTime And Converting The Date Together With High Accuracy And Most Easily That You Can Imagine . This Package Support Hijri Calendar , Jalali Calander (Persian Calendar) , Gregorian Calendar This Is The Best Tools For Converting Date To Each Other. Enjoy It

FluentGenerator

This Package Is For Auto Generating The Fixture And Infrastructure That We Need To Config And Use In TDD - BDD And All Test That We Need To Run On Sql-Server And Sql-Lite and Other Database. This Package Make All Sut And Data Infrastructure And DbContext For You In Test Drivern Design Flow This Is The Best Tools For Test Driven Design [TDD] And Behavior Driven Design [BDD] And Spec Flow Test [SpecFlow - ATDD] . Enjoy It

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 604 2/16/2024