search

fredrikekre / Literate.jl

Simple package for literate programming in Julia
https://fredrikekre.github.io/Literate.jl
Other
547 stars 64 forks source link

How to auto-generate README from literate script #176

Closed mauro3 closed 2 years ago

mauro3 commented 2 years ago

The readme of this project is the Literate file examples/README.jl. Is this auto-generated? If so, how? If not, could it be auto-generated?

fredrikekre commented 2 years ago

README.md is autogenerated from examples/README.jl with the command given in there. Or are you asking if examples/README.jl is autogenerated?

mauro3 commented 2 years ago

Auto-generated as in generated on a push to github, or something similar. Or do you run the command by hand if you update README.jl?

racinmat commented 2 years ago

My guess is that the command was ran by hand, because adding new files on push to github is rather tricky.

fredrikekre commented 2 years ago

I am running the command myself yes. Probably not that difficult to add a CI check to make sure you don't forget about it. (run the script, check that there are no changes to the readme.md file, or something like that.)