Skip to content

muhammetaydinn/teleprompter

Repository files navigation

Teleprompter Desktop

Cross-platform desktop teleprompter built with Electron.

Features

  • Lightweight desktop teleprompter UI
  • Adjustable speed and reading controls
  • Always-on-top support
  • Cross-platform packaging (Linux, Windows, macOS)
  • Auto-generated app icons from build/icon.svg

Requirements

  • Node.js 20+
  • npm 10+

Development

npm install
npm start

Code Quality

npm run lint
npm run format:check

Build Releases

Generate icons only:

npm run icons:generate

Build per platform:

npm run release:linux
npm run release:win
npm run release:mac

Build all targets:

npm run release:all

Build outputs are written to release/.

Automated release with GitHub Actions:

git tag v0.1.2
git push origin v0.1.2

This triggers .github/workflows/release.yml and uploads build artifacts to the GitHub Release automatically.

Linux Installation (AppImage)

cd release
chmod +x "Teleprompter Desktop-0.1.0.AppImage"
./Teleprompter\ Desktop-0.1.0.AppImage

If it does not start, install FUSE:

sudo apt update
sudo apt install -y libfuse2 || sudo apt install -y libfuse2t64

Signing & Notarization

See RELEASE_SIGNING.md for Windows signing and macOS notarization environment variables.

About

Cross-platform desktop teleprompter built with Electron.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors