search

SNL-WaterPower / WecOptTool-MATLAB

WEC Design Optimization Toolbox
GNU General Public License v3.0
12 stars 9 forks source link

Minor improvements to 'Getting Started' section of the documentation #171

Closed mfaltas-sandia closed 3 years ago

mfaltas-sandia commented 3 years ago

  1. Add “The link to the NEMOH repository could be found in the ‘Requirements’ section above” at the beginning of step 3 of the 'Getting Started' section. This is so that the user does not get confused when looking for the NEMOH repository if the user just skipped over to the 'Getting Started' section right away without reading the rest of the documentation. The user could also become confused with the sentence that says "Executables are provided in the 'Release' directory of the NEMOH source code" thinking that there is a specific release of NEMOH that should be downloaded from the 'Releases' section on GitHub.

  2. In part 3 of the 'Getting Started' section of the documentation, underneath the section for windows, add "The following commands should be entered into MATLAB command-line interface". This should provide more clarity to the user so that the user does not end up typing these commands into BASH or command prompt.

mfaltas-sandia commented 3 years ago

The end product of these minor changes should look something like this:

The changes are in red

image

ssolson commented 3 years ago

Hey Mina! Thank you for your helpful suggestions to improve the installation/ getting started experience. I have addressed them in the latest commit (e1de750).