search

ipfs / distributions

Legacy dist.ipfs.tech website and artifact build tools. Currently only used for notarizing builds of Kubo and IPFS Cluster.
https://dist.ipfs.tech
MIT License
48 stars 32 forks source link

Auto generate README.md for all versions listings #36

Open jbenet opened 8 years ago

jbenet commented 8 years ago

There should be README.md files inside of a distribution version listing, and inside each version listing.

Eg from https://github.com/ipfs/distributions#how-this-repo-works:

dist/index.html -- listing of all bundles available
dist/<dist> -- all versions of <dist>
dist/<dist>/README.md -- simple readme for <dist>
dist/<dist>/latest -- points to latest <version>
dist/<dist>/<version> -- dist version
dist/<dist>/<version>/README.md -- readme for <version> listing

these READMEs can be the same across versions, and should be autogenerated. They are like a human readable version of dist.json, there in case the user ends up with a big archive directory of the version. The readme could point to https://dist.ipfs.io, could point to this repository, and to `https://ipfs.io

dignifiedquire commented 8 years ago

How about the following template:

# <id>

> <tagline>

<description>

---

This page was generated from http://dist.ipfs.io. You can go there for further details, or visit us at https://ipfs.io.