Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate part of the README.md for Clause/Contract #96

Closed
dselman opened this issue May 18, 2018 · 1 comment
Closed

Automatically generate part of the README.md for Clause/Contract #96

dselman opened this issue May 18, 2018 · 1 comment

Comments

@dselman
Copy link
Contributor

dselman commented May 18, 2018

It would be very useful for maintainability, consistency, and accuracy to automatically generate part of README.md.

It could include the following generated information:

  • Required Cicero engine version
  • Name and Description (from package.json)
  • Request/response type model and samples
  • Emit type model and samples
  • Sample.txt

This should be combined with any text written by the user in README.md, perhaps using a template syntax. E.g.

{name}
{description}
Requires Cicero: {ciceroVersion}

This is my really great clause template that rules the world.

Samples
{samples}

Request Types
{requestTypes}

Reponse Types
{responseTypes}

Emitted Types
{emittedTypes}
@dselman
Copy link
Contributor Author

dselman commented Jun 22, 2018

This is now implemented on https://templates.accordproject.org

@dselman dselman closed this as completed Jun 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant