No project description provided
Project description
标准 Readme
标准 Readme 样式
README 文件是人们通常最先看到的第一个东西。它应该告诉人们为什么要使用、如何安装、以及如何使用你的代码。README 文件标准化能够使得创建和维护 README 文件更加简单。毕竟,要写好一个文档不是那么容易的。
本仓库包含以下内容:
- 一个创建标准 README 的生成器的
Python
版本。 (也许它现在还有很多问题,但是它有更多其他强大的功能正在开发中)
内容列表
背景
如果你的文档是完整的,那么使用你代码的人就不用再去看代码了。这非常的重要。它使得你可以分离接口文档与具体实现。它意味着你可修改实现的代码而保持接口与文档不变。
请记住:是文档而非代码,定义了一个模块的功能。
写 README 从某种程度上来说相当不易,一直维护下去更是难能可贵。如果可以减少这个过程,则可以让写代码与修改代码更容易,使得是否在说明中指明一处需改有无必要更加清楚,你可以花费更少的时间来考虑是否你最初的文档是否需要更新,你可以分配更多的时间来写代码而非维护文档。
同时,标准化在某些别的地方也有好处。有了标准化,用户就可以花费更少的时间来搜索他们需要的信息,他们同时可以做一个工具来从描述中搜集信息,自动跑示例代码,检查授权协议等等。
这个仓库的目标是:
- 一个生成器用来快速搭建新的 README 的框架。
安装
这个项目使用 Python3.
$ pip install md2-notfresh
为什么叫 md2-notfresh 呢? 因为 notfresh 是我的 github ID,而 md 是 markdown 的缩写,所以本来想用 md 作为命令的入口的, 但是因为 md = mkdir,被占用了,所以我用 md2 来表示.
使用说明
这是一个 README 生成工具,你可以用它快速生成一个开原仓库的README文档, 当然它本质上说是一个可自定义的 markdown 模板生成工具,更多功能正在开发中。
使用 md2 -h 来获取帮助
使用 md2 readme 在当前目录生成 README 文件
使用 md2 update-url filename 来更新md文件的网页链接
使用 md2 update-space filename 来更新md文件的英文字母和汉字的空格
# Prints out the standard-readme spec
徽章
如果你的项目遵循 Standard-Readme 而且项目位于 Github 上,非常希望你能把这个徽章加入你的项目。它可以更多的人访问到这个项目,而且采纳 Stand-README。 加入徽章并非强制的。
为了加入徽章到 Markdown 文本里面,可以使用以下代码:
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
示例
想了解我们建议的规范是如何被应用的,请参考 example-readmes。
相关仓库
- Art of Readme — 💌 写高质量 README 的艺术。
- open-source-template — 一个鼓励参与开源的 README 模板。
维护者
如何贡献
直接发我邮箱, notfresh@foxmail.com
标准 Readme 遵循 Contributor Covenant 行为规范。
贡献者
使用许可
MIT © notfresh
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for md2_notfresh-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3364c80274cfa2d131814cc444aea07a19e6fe4bf71bc093a049ee4822697bfb |
|
MD5 | fcf27c3e7b7dbd81eb9eae45e24b7e1d |
|
BLAKE2b-256 | 891caddd210911d5bea2af7f47bb1f7e681eda72c577790a4d4fcb014c8c665e |