Skip to content

Commit f798e58

Browse files
committed
Add Open in MATLAB Online links and badge
1 parent 60418d3 commit f798e58

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Programming: Structuring Code [![View <File Exchange Title> on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/115905-programming-structuring-code)
1+
# Programming: Structuring Code
2+
[![View Programming: Organizing Data on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/115900-programming-organizing-data) or
3+
[![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj)
4+
25
**Curriculum Module**
36
_Created with R2021b. Compatible with R2021b and later releases._
47

@@ -7,14 +10,16 @@ This curriculum module contains interactive [live scripts](https://www.mathworks
710

811
These scripts can be used as part of a lecture, as activities in an instructional setting, or as interactive assignments to be completed outside class.
912

10-
Get started with the Programming: Structuring Code interactive examples by downloading and unzipping the repository. Then, double-click the StructuringCode.prj file inside MATLAB&reg;. From there, you can follow the landing page instructions to get started with the examples. The instructions inside the live scripts will guide you through the exercises and activities. Get started with each live script by running it one section at a time. To stop running the script or a section midway (for example, if a loop is running longer than intended), click the <img src="https://user-images.githubusercontent.com/88841524/182219991-17ef7bf9-369b-4463-8de6-9e440ca3bc9b.png"> **Stop** button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.
13+
##Get started with the Programming: Structuring Code interactive examples##
14+
by downloading and unzipping the repository. Then, double-click the StructuringCode.prj file inside MATLAB&reg;. From there, you can follow the landing page instructions to get started with the examples. The instructions inside the live scripts will guide you through the exercises and activities. Get started with each live script by running it one section at a time. To stop running the script or a section midway (for example, if a loop is running longer than intended), click the <img src="https://user-images.githubusercontent.com/88841524/182219991-17ef7bf9-369b-4463-8de6-9e440ca3bc9b.png"> **Stop** button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.
1115

1216
## Prerequisite Domain Knowledge ##
1317
This module assumes familiarity with basic programming concepts such as floating point doubles and strings, structures including constants, vectors, matrices, and arrays, and control flows including if/else, for loops, and while loops, as well as how to use them in MATLAB. These ideas are all presented with interactive examples in [Fundamentals of Programming](https://www.mathworks.com/matlabcentral/fileexchange/103225-fundamentals-of-programming).
1418

1519
## Details ##
1620

17-
**Functions.mlx**
21+
**Functions.mlx** [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Functions.mlx)
22+
1823
Organizing code into functions improves the readability, reusability, and ease of testing. This script addresses built-in functions, refactoring code to create functions, local functions, functions defined in their own files, programmatic scope and the MATLAB path, and how to pass functions as arguments to other functions.
1924

2025
<img src="https://user-images.githubusercontent.com/88841524/182221128-9bc17fa0-a5c7-46eb-b7b5-c4ea0c770904.png">
@@ -27,7 +32,8 @@ In this script, students will...
2732
- pass functions as arguments by using function handles.
2833

2934
## ##
30-
**Debugging.mlx**
35+
**Debugging.mlx** [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Debugging.mlx)
36+
3137
Everyone makes mistakes when coding or interacting with computer programs, but you can fix these mistakes. This script introduces the MATLAB Code Analyzer, errors, warnings, breakpoints, stepping, and other tools for minimizing errors as well as identifying and removing bugs from your programs.
3238

3339
<img src="https://user-images.githubusercontent.com/88841524/174156386-854c5b9d-d07b-4a7f-810b-e11bdbfdd9c0.png" width="700">
@@ -39,7 +45,8 @@ In this script, students will
3945
- recognize and isolate run-time errors.
4046

4147
## ##
42-
**CommentingCode.mlx**
48+
**CommentingCode.mlx** [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=CommentingCode.mlx)
49+
4350
Clearly documenting and communicating your thinking is essential to program with others or even your future self. This script addresses why and how you should document and comment your code.
4451

4552
<img src="https://user-images.githubusercontent.com/88841524/182221375-2b18b9ca-75cb-4d39-8f4a-36877be20574.png">
@@ -51,7 +58,8 @@ In this script, students will...
5158

5259
## ##
5360

54-
**SharingCode.mlx**
61+
**SharingCode.mlx** [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=SharingCode.mlx)
62+
5563
Writing code for yourself is the first step, but when you create something useful or interesting, you also need to know how to share your work with others. This script offers a brief introduction to sharing your code with others.
5664

5765
<img src="https://user-images.githubusercontent.com/88841524/182222858-d25e6927-b2e8-4fc9-a70d-44200e6e5a6a.png">

0 commit comments

Comments
 (0)