Skip to content

Commit c4e8add

Browse files
committed
Update to new structure
1 parent c1f4045 commit c4e8add

File tree

142 files changed

+795
-637
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+795
-637
lines changed

.gitattributes

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
*.mexa64 binary
66
*.mexw64 binary
77
*.mexmaci64 binary
8-
*.mlapp binary
8+
*.mlapp binary linguist-language=MATLAB
99
*.mldatx binary
1010
*.mlproj binary
11-
*.mlx binary merge=mlAutoMerge
11+
*.mlx binary merge=mlAutoMerge linguist-language=MATLAB
1212
*.p binary
1313
*.sfx binary
1414
*.sldd binary

.gitignore

+22-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
# List of untracked files to ignore
22

3-
*.zip
4-
*.pyc
5-
*.pyc
6-
*.vs
7-
*TestOutput
8-
93
# Autosave files
104
*.asv
115
*.m~
126
*.autosave
137
*.slx.r*
148
*.mdl.r*
159

16-
# Derived content-obscured files
17-
*.p
10+
# MATLAB Drive
11+
*.MATLABDriveTag
1812

19-
# Compiled MEX files
13+
# Compiled files
2014
*.mex*
15+
*.p
16+
17+
# Compressed files
18+
*.zip
2119

2220
# Packaged app and toolbox files
2321
*.mlappinstall
@@ -29,13 +27,25 @@
2927
# Generated helpsearch folders
3028
helpsearch*/
3129

32-
# Code generation folders
30+
# Defined Simulink cache folder
31+
Utilities/SimulinkCache/*
32+
33+
# Standard code generation folders
3334
slprj/
3435
sccprj/
3536
codegen/
3637

38+
# Code generation file
39+
*.eep
40+
*.elf
41+
*.hex
42+
*.bin
43+
3744
# Cache files
3845
*.slxc
3946

40-
# Cloud based storage dotfile
41-
.MATLABDriveTag
47+
# Project settings
48+
Utilities/ProjectSettings.mat
49+
50+
# Test results
51+
SoftwareTests/TestResults_*

CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request. Follow the instructions in the [SECURITY.md](SECURITY.md) file in this repository._
4+
5+
Thank you for your interest in contributing to a MathWorks repository! We encourage contributions large and small to this repository.
6+
7+
**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content). We welcome issues even if you don't code the solution. We also welcome pull requests to resolve issues that we haven't gotten to yet!
8+
9+
## How to give feedback
10+
* **Send us an email:** Contact the [MathWorks teaching resources team.](mailto:[email protected])
11+
* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in. That will start a conversation with the maintainer. When you are creating a bug report, please include as many details as possible. Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.
12+
13+
## How to contribute to the repository
14+
* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). This creates an editable copy on GitHub where you can write, test, and refine your changes. We suggest that you keep your changes small and focused on the issue you submitted.
15+
* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution. When you create a pull request (see below), we'll reach out to you if you do not already have one on file. Essentially, the CLA gives us permission to publish your contribution as part of the repository.
16+
* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says: You're requesting that the maintainers of the repository pull your changes in. If you don't have a CLA on file, we'll reach out to you. Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback. Once everyone is satisfied, we'll merge your pull request into the repository.
17+
18+
## Guidelines
19+
20+
We don't have best practices for writing MATLAB® code, but we do have some recommendations:
21+
22+
* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
23+
* [Loren Shure's blog](https://blogs.mathworks.com/loren) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
24+
* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) or [Simulink® models](https://www.mathworks.com/help/simulink/index.html).
25+
* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering. If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.
26+
27+
**Again, thanks for contributing, and we look forward to your issues and pull requests!**

CommentingCode.mlx

-11.5 KB
Binary file not shown.

FunctionLibrary/.gitkeep

Whitespace-only changes.

FunctionLibrary/checkBuildWord.mlx

4.61 KB
Binary file not shown.

FunctionLibrary/checkExercise5.mlx

4.84 KB
Binary file not shown.

FunctionLibrary/checkMarkMidpoint.mlx

4.96 KB
Binary file not shown.

FunctionLibrary/conwayGameSetup.mlx

4.9 KB
Binary file not shown.

FunctionLibrary/f.mlx

3.84 KB
Binary file not shown.

FunctionLibrary/runConwayGame.mlx

5.74 KB
Binary file not shown.
Binary file not shown.

FunctionLibrary/showTaylor2.mlx

3.65 KB
Binary file not shown.

HelperFunctions/Navigation.mlx

-25.9 KB
Binary file not shown.

HelperFunctions/OpenOverview.m

-13
This file was deleted.

0 commit comments

Comments
 (0)