Package: nanodeep
Standard ReadmeA standard style for README filesYour README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work!This repository contains:The specificationfor how a standard README should look.A link toa linteryou can use to keep your README maintained (work in progress).A link toa generatoryou can use to create standard READMEs.A badgeto point to this spec.Examples of standard READMEs- such as this file you are reading.Standard Readme is designed for open source libraries. Although it’shistoricallymade for Node and npm projects, it also applies to libraries in other languages and package managers.Table of ContentsBackgroundInstallUsageGeneratorBadgeExample ReadmesRelated EffortsMaintainersContributingLicenseBackgroundStandard Readme started with the issue originally posed by@maxogdenover atfeross/standardinthis issue, about whether or not a tool to standardize readmes would be useful. A lot of that discussion ended up inzcei's standard-readmerepository. While working on maintaining theIPFSrepositories, I needed a way to standardize Readmes across that organization. This specification started as a result of that.Your documentation is complete when someone can use your module without ever
having to look at its code. This is very important. This makes it possible for
you to separate your module's documented interface from its internal
implementation (guts). This is good because it means that you are free to
change the module's internals as long as the interface remains the same.Remember: the documentation, not the code, defines what a module does.~Ken Williams, Perl HackersWriting READMEs is way too hard, and keeping them maintained is difficult. By offloading this process - making writing easier, making editing easier, making it clear whether or not an edit is up to spec or not - you can spend less time worrying about whether or not your initial documentation is good, and spend more time writing and using code.By having a standard, users can spend less time searching for the information they want. They can also build tools to gather search terms from descriptions, to automatically run example code, to check licensing, and so on.The goals for this repository are:A well definedspecification. This can be found in theSpec document. It is a constant work in progress; please open issues to discuss changes.An example README. This Readme is fully standard-readme compliant, and there are more examples in theexample-readmesfolder.Alinterthat can be used to look at errors in a given Readme. Please refer to thetracking issue.Ageneratorthat can be used to quickly scaffold out new READMEs. Seegenerator-standard-readme.Acompliant badgefor users. Seethe badge.InstallThis project usesnodeandnpm. Go check them out if you don't have them locally installed.$npminstall--globalstandard-readme-specUsageThis is only a documentation package. You can print outspec.mdto your console:$standard-readme-spec# Prints out the standard-readme specGeneratorTo use the generator, look atgenerator-standard-readme. There is a global executable to run the generator in that package, aliased asstandard-readme.BadgeIf your README is compliant with Standard-Readme and you're on GitHub, it would be great if you could add the badge. This allows people to link back to this Spec, and helps adoption of the README. The badge isnot required.To add in Markdown format, use this code:[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)Example ReadmesTo see how the specification has been applied, see theexample-readmes.Related EffortsArt of Readme- 💌 Learn the art of writing quality READMEs.open-source-template- A README template to encourage open-source contributions.Maintainers@RichardLitt.ContributingFeel free to dive in!Open an issueor submit PRs.Standard Readme follows theContributor CovenantCode of Conduct.ContributorsThis project exists thanks to all the people who contribute.LicenseMIT© Richard Littauer