diff --git a/README.md b/README.md index 9c422d8b0fef673ea518e4c48628c79ccd18c149..bf2b246a03572ebc7e0a85527f63fd9e8534d257 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,33 @@ This course presents the basic principles of software development for reliable scientific and engineering software. Using example applications, a systematic -process is given for the devel- opment and documentation of requirements, system +process is given for the development and documentation of requirements, system design, module design, implementation, testing and inspection. + +-------------------------------------------------- +### Summary of Folder Structure and File Contents +-------------------------------------------------- + +** Course Outline ** + - course outline + +** Lectures ** + - lecture material + - roughly organized following the typical "v-model" documentation (req, test, des) + - review of SE for SC + +** BlankProjectTemplate ** + - starting point for each project + - separate template for single scientific application versus family of computing libraries + +** ToolTutorials ** + - tutorials on doxygen, git and GitLab, make, unit testing and LaTeX + + ** Examples ** + - examples of SC projects + - additional examples available on-line (as pointed to in the lecture notes) + +** Reference Material ** + - papers discussed during the term + - all citations are in a BibTeX file called Reference.bib + - Format of citation labels and filenames is the AuthorYear style (https://www.e-education.psu.edu/styleforstudents/c5_p11.html)