All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Haskell Package Versioning policy.
- Update stack LTS to 18.8
- Update brick version to 0.62 (included in LTS 18.8)
- Use cabal file directly instead of package.yaml
- package.yaml as it's now not-recommended by stack
- Rename all updaters in document
- Add 'Updater' type synonym to indicate Updater function
- Add 'Updatable' type class. This allows to use all 'Updater' with any instance of Updatable
- Add 'Updatable' instance for 'Shgif'
- Use 'Rank2Types' extension in Shgif.Updater and Shgif.Type.Internal
- Shgif format: 1.0.0
- Update shgif examples to support shgif 1.0.0
- Rename all functions in 'Shgif.Updater' to generalized name
- Update all examples to use new Updater
- New Updater: 'setShgifTickTo'
- Example for 'setShgifTickTo'
- Example codes use new module names
- New module: 'Shgif.Loader'
- New module: 'Shgif.Updater'
- New module: 'Shgif.Type.Internal'
- New module: 'Shgif'
- This is for document reason. Doesn't export anything.
- Rename 'getShgif' to 'fromFile'
- Rename 'getShgifs'to 'fromFiles'
- 'fromCanvasWithMeta' is exported from 'Shgif.Loader'
- 'Shgif.Type' doesn't export:
- updateShgifNoLoop
- updateShgif
- updateShgifReversedNoLoop
- updateShgifReversed
- getShgif
- getShgifs
- updateShgifTo
- fromCanvas
- fromTartFile
- Update documents
- 'Shgif.Type.fromCanvas'
- 'Shgif.Type.fromTartFile'
- New example using fromTartFile: 'example/codes/loadFromTartFile.hs'
- Resource for above example in: 'example/resources'
- 'Brick.Extensions.Shgif.Widgets.shgifs' which will take multiple shgifs and display with merging.
- 'Brick.Extensions.Shgif.Widgets.canvas' takes [Canvas] instead of Canvas.
- Notes for
updateShgif*
functions on README - Quick Tour to make simple shgif file on docs/shgif-format.md
- docs/JA_shgif-format.md, Japanese version of docs/shgif-format.md
- New Shgif format is available! Please see docs/shgif-format.md
- Update all example Shgifs to support the new format
- New shgif viewer executable with '--reversed'/'--oneshot' flags(see its '--help')
- All example codes are moved to example/codes/ directory.
- Update gitignore file to ignore files for 'vim'/'macOS'/'haskell'
- Unused src/Lib.hs
- 'updateShgifTo' used wrong operator which seems to be reason of the freeze
- 'addInitialCanvas' now returns Shgif with canvas rendered
- You don't have to call 'updateShgif' just after 'getShgif' to render it.
- Example code in README
- 'updateShgifTo' that will update Shgif to make it closer to given tick
- Refactoring 'updateShgif' related functions with Lens
- Freezing issue after 'updateShgifReversedNoLoop' is called with tick 0
- Export 'Shgif.Type.updateShgifReversedNoLoop'
- 'updateShgifReversedNoLoop' that is no-loop version of 'updateShgifReversed'
- 'updateShgifReversed' that reverse shgif(play backwards)
- Two examples for 'updateShgifReversed'
- 'updateShgifNoLoop' that is no-loop version of 'updateShgif'
- Add missing 'added component' to Changelog (see above)
- Use Haskell Package Versioning policy instead of semantic versioning
- 'getShgif' -- Read Shgif from Yaml and generate Canvas for it
- 'getShgif' -- Read Shgif from more than one Yaml and generate Canvas for each of them
- New example to treat more than one Shgif
- 'shgif' widget isn't applied borer
- Rename 'app/Main.hs' to 'app/shgifView.hs'
- 'Shgif.Type' stop exposing 'addInitialCanvas'
- Add basic functionality to render Shgif file
- First Shgif format