search

ExtremeFLOW / neko

/ᐠ. ｡.ᐟ\ᵐᵉᵒʷˎˊ˗
https://neko.cfd/
Other
161 stars 29 forks source link

Add documentation for the user file #1138

Closed vbaconnet closed 6 months ago

vbaconnet commented 6 months ago

I am creating the PR now even though I am not done yet, in case people have strong opinions on the wording, the structure of the document or how certain things should be explained.

Will finish the other half tomorrow.

Kind of wondering if the main page index.md should be made prettier... maybe not a priority though.

njansson commented 6 months ago

Great stuff!

vbaconnet commented 6 months ago

I think this is more or less finished! I guess things to discuss could be how things are explained, the wording, nomenclatures, and/or vocabulary, etc.

vbaconnet commented 6 months ago

Removed the don't merge label :)

timofeymukha commented 6 months ago

Wrapped the text by col80.

timofeymukha commented 6 months ago

Great job, just a few suggestions. I also added a mention of the Neuman bc to the scalar_bc user function, a bit ahead of time :-).