Documentation - Githubissues

euroargodev / matlab_profiles_visualization

A Matlab GUI to work with Argo data

3 stars 2 forks source link

Documentation #1

Open gmaze opened 4 years ago

gmaze commented 4 years ago

Hi @gnotarstefano, Can you please provide us with more information and some guidelines about how to use this software.

It is as simple as a README.md file with the standard elements:

[x] Software title
[x] Software purpose
[x] Requirements
[x] How to use
[ ] A snapshot of the GUI

You can check the very good README from @imab4bsh at https://github.com/euroargodev/check_CTD-RDB to get you started.

gnotarstefano commented 4 years ago

Hi Guillaume, I've done the README file. The link https://github.com/euroargodev/check_CTD-RDB does not work Giulio

gmaze commented 4 years ago

Hi @gnotarstefano Great start ! I created a pull request (PR) with modification to the README to proper use the markdown text formatting, if you agree with changes, you can accept the PR.

otherwise, yes the https://github.com/euroargodev/check_CTD-RDB is a private repo, so you should ask @imab4bsh for access.

imab4bsh commented 4 years ago

Hi @gnotarstefano I just changed the settings of the repo to make it public. I removed the most sensitive data in the examples (T & S profiles, and TS diagrams for all profiles inside each box) which was the reason the repo was not public before! 🌞