virtualbow
virtualbow copied to clipboard
Update documentation for Version 0.10
User manual
- [ ] Document that files older than 0.7 are no longer supported
- [ ] Document changes to the inputs and outputs
- [ ] Input/Output formats: Documenting those is starting to get tiresome. Maybe refer to Rustdoc when ready.
- [ ] Add new section about limitations
- [ ] When explaining the new arrow mass definitions, add a conversion table for gpp to grams/Newton and grams/Joule for different draw lengths
Theory manual
- [ ] Document stress evaluation for the layers
- [ ] Document evaluation of stresses and strains for the new beam elements
- [ ] Include source for choice of corotational reference frame https://apps.dtic.mil/sti/tr/pdf/ADA358178.pdf
- [ ] Completely revise the theoretical documentation, remove old stuff
- [ ] Move verification examples into their own LaTex document
- [ ] Document new reference beams and remove old ones
Repository
- [ ] Document Rust build and test process, e.g.
cargo test --release --features "plotters" - [ ] Mention that CI treats warnings as errors, show clippy command
- [ ] Revise all Readme files, maybe add new ones to some of the folders
- [ ] Include a screenshot in the main Readme