Skip to content
Snippets Groups Projects
Commit 01ce5e29 authored by W. Spencer Smith's avatar W. Spencer Smith
Browse files

Updates to Readme file to explain folder contents

parent 205f1911
No related branches found
No related tags found
No related merge requests found
......@@ -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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment