Skip to content

Commit

Permalink
Add release notes and update pack script
Browse files Browse the repository at this point in the history
Stop on errors, build a .pdf documentation and also the release
notes.
  • Loading branch information
hth313 committed May 19, 2017
1 parent d6d5e77 commit 0e22dd2
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Release Notes for Ladybug

## Important information

Ladybug is a bank switched module which consists of three pages. Ensure that you load it properly into your HP-41 for correct operation. The supplied `.mod` file is properly configured for this, but if you extract the pages and do it manually, be careful!


## Version 0B

Minor update, May 19, 2017.

### Notes

* Includes an overlay for i41CX+ emulator (iPhone) contributed by Robert Meyer.

* A `.pdf` version of the documentation is now part of the distribution.

* Various updates have been made to the documentation.

### Corrections

* The buffer created by Ladybug is no longer removed by "`PACK`" or "`GTO ..`". The buffer would be removed if such operation was invoked before turning the calculator off (at least once).

* Ladybug now works properly with very early HP-41C calculators.

* No longer crashes if another module misbehaves and leave a secondary bank enabled when returning to the operating system, and that module is located in such a way that the bank switch mechanism is shared with Ladybug.

* Minor change to the `.mod` file metadata to avoid any possible confusion to the module reader on how to group and locate the pages.


## Version 0A

Original release for early adaptors, January 10, 2017.
7 changes: 7 additions & 0 deletions scripts/pack
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
#!/bin/bash

# Stop on failure
set -e

# Build module and documentaiton
pushd src
make
popd
pushd doc
make html
make latexpdf
markdown ReleaseNotes.md >ReleaseNotes.html
popd

# Set up a dist folder
rm -rf dist
mkdir dist
cp src/ladybug.mod dist/
cp -R doc/_build/html dist/doc
cp doc/_build/latex/ladybug.pdf dist/doc
cp doc/ReleaseNotes.html dist/

# Clean up some stuff we do not want
rm -rf dist/doc/_sources
Expand Down

0 comments on commit 0e22dd2

Please sign in to comment.