Installation

First, download the installer for your operating system. Then, follow the instructions below for your operating system.

Download Korppi

Installing on Linux

Option 1: AppImage (Recommended)

Download the .AppImage file from the releases page
Make it executable:

chmod +x korppi_*.AppImage

Run it:

./korppi_*.AppImage

Option 2: Building from Source

Requirements:

# Clone the repository
git clone https://github.com/b-rodrigues/korppi.git
cd korppi

# Drop into the development shell
nix develop

# Install Node.js dependencies
npm install

# Build an appimage
npm run tauri build -- --bundles appimage

# Build a deb (untested)
npm run tauri build -- --bundles deb

# Build an rpm (untested)
# Note: On Debian/Ubuntu, you may need to install 'rpm' first: sudo apt install rpm
npm run tauri build -- --bundles rpm

Installing on macOS

Download the .dmg file from the releases page
Open the DMG file
Drag Korppi to your Applications folder
Because the app is not signed or notarized, macOS will block it the first time. Open a terminal and run this command:
```
xattr -cr /Applications/Korppi.app
```

Installing on Windows

Download the .exe installer from the releases page (unless you have an ARM device, download the x86-setup.exe)
Run the installer
Follow the installation wizard (admin rights are not required)
Launch Korppi from the Start menu

Verifying Your Installation

After installation, launch Korppi. You should see:

The main editor window
Left sidebar with formatting tools
Right sidebar with timeline panel

If you encounter any issues, check the Troubleshooting page.

Next Steps

Ready to start writing? Check out the Quick Start Guide!