Skip to content

Commit

Permalink
Merge pull request #7 from bxparks/develop
Browse files Browse the repository at this point in the history
merge 0.3.3 into master
  • Loading branch information
bxparks authored Aug 14, 2023
2 parents f9aa1b4 + c982909 commit c540246
Show file tree
Hide file tree
Showing 5 changed files with 151 additions and 171 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog

- Unreleased
- 0.3.3 (2023-08-14)
- Add `Makefile` targets for converting GitHub markdown files to PDF files.
- Update some sections in `README.md` and `USER_GUIDE.md`.
- No code change.
- 0.3.2 (2023-08-13)
- Add executive summary of the app at the top of README.md.
- No code change.
Expand Down
53 changes: 53 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Convert GitHub-flavored Markdown to PDF, including embedded images.
#
# Requires pandoc and pdflatex. Here are the stackoverflow articles that helped
# me solve this problem:
#
# - https://stackoverflow.com/questions/9998337 (pandoc)
# - https://stackoverflow.com/questions/29240290 (pdflatex not found)
# - https://stackoverflow.com/questions/13515893 (margin size)
# - https://stackoverflow.com/questions/23811002 (fontsize)
#
# I use '-f gfm' instead of '-f markdown' to handler embedded images better.
# The `-f mardown` option separates out the images into separate Figures which
# are out of context from the text. The `-f gfm` embeds the images directly
# into the flow of the text.

TARGETS := README.pdf \
USER_GUIDE.pdf \
rpn83p.8xk \
rpn83p-example1.gif \
rpn83p-example2.gif

# Create a zip file suitable for third party archives, like cemetech.net and
# ticalc.org.
rpn83p.zip: $(TARGETS)
rm -f $@
zip -r $@ $^

# Convert markdown to PDF.
README.pdf: README.md Makefile
pandoc -V geometry:margin=1in -V fontsize=12pt -f gfm -s -o $@ $<

# Convert markdown to PDF.
USER_GUIDE.pdf: USER_GUIDE.md Makefile
pandoc -V geometry:margin=1in -V fontsize=12pt -f gfm -s -o $@ $<

# Copy to local directory to place it at top level in the zip file.
rpn83p.8xk: src/rpn83p.8xk
cp -f $< $@

# Compile the binary if needed.
src/rpn83p.8xk: src/*.asm
$(MAKE) -C src rpn83p.8xk

# Copy the animated GIF as a sample screenshot.
rpn83p-example1.gif: docs/rpn83p-example1.gif
cp -f $< $@

# Copy the animated GIF as a sample screenshot.
rpn83p-example2.gif: docs/rpn83p-example2.gif
cp -f $< $@

clean:
rm -f $(TARGETS)
39 changes: 15 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,27 +48,28 @@ Here the quick summary of its features:
- `SCI` (scientific 0-9 digits)
- `ENG` (engineering 0-9 digits)

**Version**: 0.3.2 (2023-08-13)
**Version**: 0.3.3 (2023-08-14)

**Changelog**: [CHANGELOG.md](CHANGELOG.md)

**Project Home**: https://github.com/bxparks/rpn83p

**User Guide**: [USER_GUIDE.md](USER_GUIDE.md)

## Table of Contents

- [Installation](#Installation)
- [Supported Hardware](#SupportedHardware)
- [Quick Examples](#QuickExamples)
- [Example 1](#Example1)
- [Example 2](#Example2)
- [User Guide](#UserGuide)
- [Compiling from Source](#Compiling)
- [Tools and Resources](#ToolsResources)
- [License](#License)
- [Feedback](#Feedback)
- [Author](#Author)

<a name="Installation"></a>
- [Installation](#installation)
- [Supported Hardware](#supported-hardware)
- [Quick Examples](#quick-examples)
- [Example 1](#example-1)
- [Example 2](#example-2)
- [User Guide](#user-guide)
- [Compiling from Source](#compiling-from-source)
- [Tools and Resources](#tools-and-resources)
- [License](#license)
- [Feedback](#feedback)
- [Author](#author)

## Installation

RPN83P is a flash application that is packaged as a single file named
Expand Down Expand Up @@ -97,7 +98,6 @@ Since the RPN83P is a flash app, it is preserved when the RAM is cleared. It
consumes about 300 bytes of RAM space for its internal RPN and storage
registers.

<a name="SupportedHardware"></a>
### Supported Hardware

This app was designed for TI calculators using the Z80 processor:
Expand All @@ -110,10 +110,8 @@ This app was designed for TI calculators using the Z80 processor:
I have tested it on the two Z80 TI calculators that I have (both Silver
Edition). It *should* work on the others, but I have not actually tested them.

<a name="QuickExamples"></a>
## Quick Examples

<a name="Example1"></a>
### Example 1

Let's compute the volume of a sphere of radius `2.1`. Recall that the volume of
Expand Down Expand Up @@ -142,7 +140,6 @@ Here is an animated GIF that shows this calculation:
(Note that the RPN83P provides a `X^3` menu function that could have been used
for this formula, but I used the `LastX` feature to demonstrate its use.)

<a name="Example2"></a>
### Example 2

Let's calculate the bitwise-and operator between the hexadecimal numbers `B6`
Expand Down Expand Up @@ -179,12 +176,10 @@ Press:

> ![ROOT MenuStrip 1](docs/rpn83p-screenshot-menu-root-1.png)
<a name="UserGuide"></a>
## User Guide

See the [RPN83P User Guide](USER_GUIDE.md).

<a name="Compiling"></a>
## Compiling from Source

I use Ubuntu Linux 22.04 for my development. The following instructions have
Expand All @@ -203,7 +198,6 @@ been verified only on my dev machine.
- `$ make`
- Should produce a file named `rpn83p.8xk`.

<a name="ToolsResources"></a>
## Tools and Resources

Here is the tools and resources that I use for development on Ubuntu Linux
Expand Down Expand Up @@ -257,12 +251,10 @@ Here is the tools and resources that I use for development on Ubuntu Linux
place that I know which explains how to generate a flash app using the
`spasm-ng` assembler.

<a name="License"></a>
## License

[MIT License](https://opensource.org/licenses/MIT)

<a name="Feedback"></a>
## Feedback and Support

If you have any questions, comments, or feature requests for this library,
Expand All @@ -278,7 +270,6 @@ Please refrain from emailing me directly unless the content is sensitive. The
problem with email is that I cannot reference the email conversation when other
people ask similar questions later.

<a name="Author"></a>
## Author

Created by Brian T. Park (brian@xparks.net).
Loading

0 comments on commit c540246

Please sign in to comment.