generated from NCSU-Libraries/ncsu_apprentice
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from moiradowney/moiradowney-software_docs
Moiradowney software docs
- Loading branch information
Showing
3 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.