alecjacobson / gptoolbox

Matlab toolbox for Geometry Processing.
MIT License
628 stars 166 forks source link

Improve Documentation by Providing Function List #161

Open nkh0472 opened 6 months ago

nkh0472 commented 6 months ago

Currently, documentation is only available on a per-function basis. Thus, I believe listing the available functions could prove quite useful. If users are unaware of these functions' existence, they won't know the full capabilities of the toolbox or what to learn. This list could be included in the README file (initially collapsed as it might be lengthy), saved as a CSV in the root folder, or displayed in MATLAB in some manner.

The MathWorks File Exchange has already compiled such a list. It might be unnecessary to duplicate this effort in the source code.

However, I suggest not redirecting users to MathWorks for learning purposes. Instead, placing the function list in the root folder would allow users to easily locate it.

An example function list.csv