Fork the repository to get your own copy of the custom-scripts
It is easiest to fork the repository on GitHub, but as some of you might not have GitHub account, or don’t want to bother with all this versioning and collaboration tools, you can also just download the whole repository as Zip file and work from there.
Create a new directory entry for your custom script
example directory to proper directory, based on which datasource (satellite) you are publishing the product for, to something that describes what the product is about, say
Preferably use “snake_case” (underscores instead of spaces) if more than one word is used.
Fill in the details about the project in the
Obviously, you’ll want to remove this chapter, but use the rest of the file as a template.
Have a look around at other
README.md files to see how to include images, format the text and generally use the GitHub markdown (e.g. here for mathematical formulas or here for adding images).
Implement the product in the
example folder includes an empty custom script with comments that will hopefully help you build your own custom script. Of course the easiest is to do the custom script building/testing on Sentinel Playground.
Add an entry pointing to your script to the main readme file.
A link and a short description will do.
And create a pull request :). There is extensive help on creating pull requests on GitHub help, but if you feel overwhelmed by this step and would still like to contribute, send us the folder you’ve created and we will take care of it for you.
Publishing your product should be easy, nevertheless, any feedback and ideas how to improve or make the process simpler is very appreciated.