Skip to content

Commit

Permalink
Merge pull request #8 from moiradowney/moiradowney-software_docs
Browse files Browse the repository at this point in the history
Moiradowney software docs
  • Loading branch information
moiradowney authored Oct 17, 2024
2 parents bcf14cc + 3b76f48 commit 5c33971
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions _slides/software_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---

order: 200

---

## Software Documentation

<div>
<div class="two-col left">
<p>Be sure that the README file for your code includes all the software versions, packages and libraries necessary to run your code</p>
</div>
<div class="two-col right">
<figure>
<img src="{{ site.baseurl }}/assets/img/slides/read-me_documentation.jpg"
alt="README file with dependencies" width="400" />
</figure>
</div>

<div>
<div class="two-col left">
<p>Your code should also have intelligible inline comments, and that variables and functions have descriptive, human readable names</p>
</div>
<div class="two-col right">
<figure>
<img src="{{ site.baseurl }}/assets/img/slides/in-line_comments.jpg"
alt="Example of in-line code documentation" width="400" />
</figure>
</div>
Binary file added assets/img/slides/in-line_comments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/slides/read-me_documentation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c33971

Please sign in to comment.