search

jontejj / jargo

Argument and options parser for java
Other
1 stars 1 forks source link

Provide utility-method to automate updating README.md #25

Open tomasbjerre opened 5 years ago

tomasbjerre commented 5 years ago

I often find myself:

  1. Running my program with -h
  2. Manually copying output
  3. Manually pasting that output into a section of my README.md.

Would be nice with some utility-method that takes a section in the README and replaces it with updated docs. Users can invoke that utility method using a test case or whatever. And always have up-to-date usage in README.md.

To show what I mean, have a look at updateReadmeWithReporters here: https://github.com/tomasbjerre/violations-lib/blob/master/src/main/java/se/bjurr/violations/lib/util/Utils.java

jontejj commented 5 years ago

Maybe it would be better to use the "include-files feature of markdown? https://docs.microsoft.com/en-us/contribute/how-to-write-use-markdown#include-files less searching and replacing that way. And the code to produce the file would be so simple that I don't think it necessitates a function in the library?

jontejj commented 5 years ago

(sorry for the late answer!!!)