Files
meetingnotes/README.md
T

4.8 KiB

Logo

Meetingnotes

The Free, Open-Source AI Notetaker for Busy Engineers
Download for MacOS 14+

https://github.com/user-attachments/assets/cadd4504-e9d9-4ccd-874d-41d8a84f4c9d

Features

Implemented:

  • Recording mic & system audio
  • Live transcript
  • Ability to also write down additional notes
  • AI generated enhanced notes
  • Copy functionality
  • Meeting deletion functionality
  • Meeting search functionality
  • Abilty to edit system prompt
  • Use your own API key
  • Auto updates
  • Text formatting
  • Different note templates
  • Integrate with Posthog for anonymous analytics (installs, opens, meetings created)
  • Onboarding screen to enable settings and set API key

Todo:

  • check for funds / validity of openai api key
  • add padding to text inputs
  • add confirmation when clicking the copy button

Later:

  • Cool recording indicator (dancing bars)
  • Connecting to your Google calendar
  • AI chat for asking questions about a meeting
  • Ability to use different models
  • Ability to use different STT providers
  • Integrations for email, Slack, Notion, etc.

Local Development

Open the project in Xcode. Command+R to build it and run it.

Releasing a New Version

Follow these steps to create a new release with auto-updates:

Prerequisites

  • Homebrew packages: brew install create-dmg sparkle
  • Make scripts executable: chmod +x scripts/update_version.sh scripts/build_release.sh

Release Process

  1. Update the version number:

    # For bug fixes (1.0 → 1.0.1):
    ./scripts/update_version.sh patch
    
    # For new features (1.0 → 1.1):
    ./scripts/update_version.sh minor
    
    # For major changes (1.0 → 2.0):
    ./scripts/update_version.sh major
    
    # For custom version:
    ./scripts/update_version.sh custom 1.2.0
    
  2. Build the release:

    ./scripts/build_release.sh
    

    This will:

    • Clean build the app in Release mode
    • Create a signed DMG file
    • Generate the appcast.xml for auto-updates
  3. Create GitHub Release:

    • Go to GitHub Releases
    • Click "Create a new release"
    • Tag: v1.0.1 (match the version number)
    • Title: Meetingnotes v1.0.1
    • Upload the DMG and zip files from releases/ folder
    • Generate release notes
  4. Update appcast:

    git add appcast.xml
    git commit -m "Update appcast for v1.0.1"
    git push