Checklist for 1.4 release

[rlafuente]

Docs:

• Clean documentation stubs
• Update install docs
• Update getting started
• Add Atom docs
• Add video export docs
• Finish changelog
• Write release announcement based on changelog
• Check if Jupyter docs are correct (I think the bit about using virtualenv is incorrect)

Home page:

• Update the home page with example screenshots

Nice-to-have:

• Make screenshots for Getting started, Live variables pages
• Docs issues (the gen_index.html looks weird, can we fix it so we can use it?)

This is mostly a TODO list for me but feel free to chime in!

[stuaxo]

There's one in this ticket here (may be out of date)
#266

It also has a list of changes up to a point some months ago, that might make the start of a changelog.

[rlafuente]

Thanks! I looked for that issue but didn't find it and got distracted -- I'll port those over to here as a way to go through everything.

[rlafuente]

I'll use this comment for the changelog, since it's easier to edit here with the issue links.

Blocking issues (must have):
#264 #265 #274 #275 #277 #283 #285 #287 #289 #312 #247 #322

Not as important issues (should have):
#288 #290 #296 #291 #315

Outstanding from previous release (could have) #202
#155

(this is the Shoebot changelog, but everywhere else it's worth mentioning the new Jupyter and Atom packages)

Changes since v1.3.1:

Highlights:

• Variable fonts! Fonts with variant axes can now be loaded and tweaked. Thanks to @villares for the nudge. (Variable fonts #339)
• Improved typography control with settings for tracking (letterspacing), underline and overline, along with the new fontnames(), textbounds() and fontoptions() commands (Text should accept font, fontsize, weight. #283 Implement letterspacing and under/overlines #351 Add Text.bounds() and textbounds() #356 Implement fontoptions() #391)
• Stroke and fill features: strokecap(), strokejoin(), strokedash() and fillrule() (Add blending modes and missing fill/stroke features #376)
• Arcs! They can now be drawn with the arc() and arcto() commands. (Finish implementing arcs #343)
• Blending modes for all drawing objects (Add blending modes and missing fill/stroke features #376)

Other new features:

• Much improved unit test framework that already helped us find and kill several bugs, and made it possible to implement new features with confidence that things don't break. (Integration test (not CI / travis) that runs all examples. #296)
• Main loop refactoring, a backend rework that fixed many longstanding bugs (25cf830)
• Commands that set state (like fill() or font()) now always return its current value
• image() can properly load SVG files (Fix bug in img library when using svgs. #277)
• Add (x,y) coordinates to closepath() (Add x, y coordinates to Close Path command. #287)
• The dependency install script was improved and has added support for Homebrew, Manjaro, Arch (thanks to @villares for help and testing) and MINGW64 (thanks to @speters33w for help and testing) (Update install_dependencies to include mingw64 #312)
• Significant speedups by removing unnecessary waits (Improve run speed by trimming sleep() time in background thread #372)
• Windows/Mingw64: working Gedit extension
• OSX: Improvements in dependency installing (Try using install dependencies on osx. #264)

Cleanups:

• Remove CMYK references and only use RGB internally (Remove remaining references to CMYK #386)
• Remove the Drawbot mode (never properly implemented) (Remove drawbot.py and references, keep a stub for someday #375)

Bug fixes:

• Error codes are properly output on exit (Feature/test commands can start #284 Set errorcode on script-error exit (and don't add a new exception). #374)
• Fix unstroked shapes being rendered as bitmaps (Fix unstroked shapes being rendered as bitmaps #359)
• Fix line() being a closed path
• Fix crash when using HSB colors
• Fix L-System library bugs (Bugfix/lsystem fixes #290)
• Fix wrong line number output in script errors
• Fix colormode to take range, not crange for Nodebox compatibility
• Fix broken Text.draw()
• Fix socket server not starting because of new Python 3 API changes. (Fix socket server not starting #368)
• Update pubsub version (import shoebot question/issue #265)

Docs were seriously reworked:

• Many new examples in the command reference
• Many, many corrections, fixes and edits
• Move from ReadTheDocs to our own Sphinx site at docs.shoebot.net
• New look and name (Shoebot manual)
• Recommends per-user install, not system-wide
• Update Sphinx module to Python 3 and correct leftover Python 2 references (Make docs build with python 3 #275)
• Remove reference to Shoebox appliance as this was not updated to Python 3

Testing:

• Add OSX support to end to end tests.
• Update unit tests to use AAA style.
• Add checks to ensure travis and the install script are consistent
• Add missing packages to travis for homebrew and ubuntu.
• Add end to end tests that visual output of some examples
• Add tests for exception format.
• (Re)Add tests for color.

Libraries:

• Port various bits to Python 3
• Cleanups and reformatting, including the colors library
• Fixes in the lsystem and graph libraries and examples
• SBVideo alert the user if numpy is not installed
• Remove the web library as it's stale and obsolete (Web library needs porting to python 3 #288)

Examples:

• Add Dendrite and Fireworks example from Nodebox
• Update Pure Data example

[stuaxo]

Re-pasted in the list of issues (I was manually putting lines through the closed tickets) - there may be more closed since then.

[stuaxo]

Small writeup on work on work to fix runs-3-times up to now, and upcoming:
#247 (comment)

[stuaxo]

@rlafuente some small things have come up that make 1.4.2 worth releasing.. should we move stuff to there or keep it here ?

There's some longer term bits on here, and the things that concern me most are little bugs we've fixed, though I'm sure more stuff can go in too..

#437