Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 1.85 KB

Example.md

File metadata and controls

73 lines (45 loc) · 1.85 KB

UnifieReadme

UnifieReadme : Build custom readme templates for all projects to ensure consistency and clarity of the code base.

中文版本 (Chinese Version)

Table of Contents

Security

...

Background

...

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

$ npm install --global standard-readme-spec

Usage

This is only a documentation package. You can print out spec.md to your console:

$ standard-readme-spec
# Prints out the standard-readme spec

Generator

To use the generator, look at generator-standard-readme. There is a global executable to run the generator in that package, aliased as standard-readme.

API

...

More optional sections

...

Contributing

...

License

Distributed under the MIT © 2024 hujinghao | 中国科学院大学 (UCAS). See LICENSE for more information.