README is not selling - Githubissues

JuliaFEM / FEMBeam.jl

Beam implementation for JuliaEFM

MIT License

5 stars 4 forks source link

README is not selling #15

Open ahojukka5 opened 6 years ago

ahojukka5 commented 6 years ago

Some simulation example with beam elements would be nice to have in README, including graphics. In the same way than in FEMPlates.jl.

TeroFrondelius commented 6 years ago

Is it possible to use Literate.jl to generate the README example? When adding some test at the end we can easily follow if the example breaks.

ahojukka5 commented 6 years ago

I think it's not easy to do that way because README.md is usually a static file inside the repository. But we could include the example in the documentation using Literate of course.