spaceml-org / GIBS-Downloader

GIBS Downloader is a command-line tool which facilitates the downloading of NASA satellite imagery and offers different functionalities in order to prepare the images for training in a machine learning pipeline.
http://spaceml.org/repo/project/605b7b751644770011e850c3/false/
Apache License 2.0
44 stars 8 forks source link

Define command line tool according to UNIX man pages #5

Open sidgan opened 3 years ago

sidgan commented 3 years ago

Example: https://man7.org/linux/man-pages/man1/cd.1p.html

sidgan commented 3 years ago

Also, let the user know if this can work on Windows, UNIX only etc. This should also be mentioned in the first description paragraph NASA-GIBS-Downloader is a XYZ command-line tool

sidgan commented 3 years ago

The man page style documentation will be in brief in the README, but in the Sphinx style documentation will be more detailed https://github.com/spaceml-org/NASA-GIBS-Downloader/issues/7