This is just a first draft of an update on readme file for documentation.
Additions
1- A folder name images under the doc is added to include all the images that will be use in readme.md file
2- Structure of folders added
3- Installation requirement for windows user (on WSL) is added. @JurgenZach-NOAA if you have any additional comments on installation and possible issues on WSL please feel free to add
Removals
-
Changes
-
Testing
1.
Screenshots
Notes
-
Todos
-
Checklist
[ ] PR has an informative and human-readable title
[ ] Changes are limited to a single goal (no scope creep)
[ ] Code can be automatically merged (no conflicts)
[ ] Code follows project standards (link if applicable)
[ ] Passes all existing automated tests
[ ] Any change in functionality is tested
[ ] New functions are documented (with a description, list of inputs, and expected output)
[ ] Placeholder code is flagged / future todos are captured in comments
[ ] Visually tested in supported browsers and devices (see checklist below :point_down:)
[ ] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
[ ] Reviewers requested with the Reviewers tool :arrow_right:
This is just a first draft of an update on readme file for documentation.
Additions
1- A folder name
imagesunder thedocis added to include all the images that will be use in readme.md file 2- Structure of folders added 3- Installation requirement for windows user (on WSL) is added. @JurgenZach-NOAA if you have any additional comments on installation and possible issues on WSL please feel free to addRemovals
-
Changes
-
Testing
1.
Screenshots
Notes
-
Todos
-
Checklist
Testing checklist
Target Environment support
Accessibility
Other