Skip to content

Commit

Permalink
updating readmes and metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
mcfunley committed Nov 5, 2024
1 parent 9ec8546 commit 926bca6
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# keynote-export

This is a script that can export Keynote presentations in formats that are better for sharing them as standalone documents. Natively,
This is a program that can export Keynote presentations in formats that are better for sharing them.

* It generates an html presentation in a [minimalist, reader-friendly format](https://boringtechnology.club).
* It generates a nicely-formatted PDF [like this one](https://speakerdeck.com/mcfunley/deploying-often-is-a-very-good-idea), suitable for uploading to Speakerdeck or others.

Natively,

* Keynote will export slides with presenter notes as a PDF. But the resulting formatting is terrible, giving 50% of each page of the PDF up to the notes.
* Keynote will export an HTML document, but it won't include presenter notes with it.

This script addresses both of these issues.

* It generates a nicely-formatted PDF [like this one](https://speakerdeck.com/mcfunley/deploying-often-is-a-very-good-idea), suitable for uploading to Speakerdeck or others.
* It generates an html presentation in a minimalist, reader-friendly format inspired by [Maciej Cegłowski](http://idlewords.com/talks/).
This program addresses both of these issues.

## Setup
You can install this program using [pipx](https://github.com/pypa/pipx):
Expand Down
21 changes: 21 additions & 0 deletions pypi-readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# keynote-export

* It generates an html presentation in a [minimalist, reader-friendly format](https://boringtechnology.club).
* It generates a nicely-formatted PDF [like this one](https://speakerdeck.com/mcfunley/deploying-often-is-a-very-good-idea), suitable for uploading to Speakerdeck or others.

## Setup
You can install this program using [pipx](https://github.com/pypa/pipx):

pipx install keynote-export

## Usage

Use `keynote-export --help` to see all of the available options. Basically,

```
keynote-export \
--keynote=<the keynote file> \
--outdir=<a path> \
--title=<the name of the presentation> \
--bluesky-handle=<your BlueSky username>
```
17 changes: 16 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,22 @@ version = "0.1.4"
description = ""
authors = ["Dan McKinley <[email protected]>"]
repository = "https://github.com/mcfunley/better-keynote-export"
readme = "README.md"
readme = "pypi-readme.md"
license = "MIT"
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: MacOS X",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Intended Audience :: End Users/Desktop",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: MacOS :: MacOS X",
"Topic :: Multimedia :: Graphics :: Presentation",
"Topic :: Office/Business",
"Topic :: Utilities"
]

[tool.poetry.scripts]
keynote-export = "keynote_export:main"
Expand Down

0 comments on commit 926bca6

Please sign in to comment.