Write README.rst
jcsmithhere opened this issue · comments
We need an intro README!
Include an introduction and some basic examples of functionality. The README should be a very quick introduction to the package to give users within a couple minutes a good idea of what functionality the package provides. Pretty pictures and animations are always good! Then at the end of the README the user is referred to the Jupyter notebook tutorial for more details.
Started in 5ec1366 in bdf-implementation Should add photos, animations of usage. A good animation would maybe be one like in the README of lightkurve which highlights how easy the package is to use.
Your ideas all sound good, @anthonyozerov !
I recommend adding a couple pretty figures to the README.rst to draw in the user. Perhaps a good figure of a globe scatter plot, a time histogram and a bolide light curve. Some eye candy to attract a user.
Just added a preview gif demonstrating some plotting in 50e6d30.
Your preview gif looks great! I recommend slowing down the speed. The commands scroll off screen very quickly and is difficult to read what you typed in time before it's gone.