Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akyoto/readme
Readme generator.
https://github.com/akyoto/readme
generator go readme
Last synced: about 23 hours ago
JSON representation
Readme generator.
- Host: GitHub
- URL: https://github.com/akyoto/readme
- Owner: akyoto
- License: other
- Created: 2019-05-05T13:22:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-22T15:00:38.000Z (almost 3 years ago)
- Last Synced: 2024-06-20T03:45:38.282Z (5 months ago)
- Topics: generator, go, readme
- Language: Go
- Size: 23.4 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# readme
[![Godoc][godoc-image]][godoc-url]
[![Report][report-image]][report-url]
[![Tests][tests-image]][tests-url]
[![Coverage][coverage-image]][coverage-url]
[![Sponsor][sponsor-image]][sponsor-url]
Readme generator.
## Installation
```shell
go get -u github.com/akyoto/readme/...
```
## Usage
```shell
readme
```
Generates `README.md` files for every subdirectory that has a `README.src.md` file.
## Snippets
```text
name
```
Repository name.
```text
go:header
```
Header for Go projects.
```text
go:footer
```
Footer for Go projects.
```text
go:install
```
Installation instructions for Go projects.
[godoc-image]: https://godoc.org/github.com/akyoto/readme?status.svg
[godoc-url]: https://godoc.org/github.com/akyoto/readme
[report-image]: https://goreportcard.com/badge/github.com/akyoto/readme
[report-url]: https://goreportcard.com/report/github.com/akyoto/readme
[tests-image]: https://cloud.drone.io/api/badges/akyoto/readme/status.svg
[tests-url]: https://cloud.drone.io/akyoto/readme
[coverage-image]: https://codecov.io/gh/akyoto/readme/graph/badge.svg
[coverage-url]: https://codecov.io/gh/akyoto/readme
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
[sponsor-url]: https://github.com/users/akyoto/sponsorship