At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Here’s how to make animations like this one. It requires intermediate Unix command-line knowledge, to install some tools and to debug if they don’t work. You’ll need these utilities:
curl (or you can translate to wget)convert and montage, part of ImageMagickffmpeg, plus whatever codecsparallel, for iteration that’s nicer than shell for loops or xargszsh for leading 0s in numerical ranges to work
| 9254835974458887629672873635789957411886024698554157393849494864228024962939550688297074527198420261051675205999609689838587412 | |
| 7948702662533481896767559573369920938242346354580061545409242090168773727371802699309443935396635866263937828773324526334321892 | |
| 7929250312741837331511829643632683169694074912332726993582394725302853411901337696207186358524323117172520907433878952968176465 | |
| 9486937364148093931718552300016332142708943190856638524388888569011747617956915519539025796115901484762122047712200094207683584 | |
| 0703675740855407318047361595661595146837376373951978537785605481083388906490085533348547865459237835407372374738389274773789264 | |
| 3524314516560200536698529022539598732463389124803873184044464663165630452635665559603483233341839268186056673186867104904449866 | |
| 3388466377320953222057779182433549144340237502432464295061371141084500222833875925546082542869030852833895137466510262849050187 | |
| 2359980877010447170873386178573828860442255448874794721230413368694441497441338856684036949118353204002591974711928301953002372 |