NoteismNoteismDocs

Installation

Real install paths for Linux, preview notes for macOS and Windows, and the source-build route when you want the whole thing under your hands.

Release source of truth

Use the latest GitHub release as the canonical source for Noteism builds:

Keep it simple

If a package, binary, or installer is not present on the latest release page, do not assume it exists somewhere else. The release page is the truth.

Support status by platform

PlatformCurrent reality
Linux Mint / Ubuntu / DebianBest current path via .deb builds when present on the release page
Other Linux distrosBuild from source unless a maintained release artifact exists
macOSPreview builds may be available, but signing work is still in progress
WindowsPreview builds may be available, but extra testing and bug reports are still valuable

Linux

If the release includes a .deb, this is the cleanest path today for Linux Mint and Ubuntu users.

Download the .deb asset from the latest release.
Open a terminal in the download directory.
Install it with sudo apt install ./noteism_*.deb.
Launch Noteism from your app menu or by running noteism.
cd ~/Downloads
sudo apt install ./noteism_*.deb

Why `apt install` instead of `dpkg -i`?

apt install ./file.deb handles dependency resolution for you. Less cleanup, less swearing.

Debian users can use the same .deb route when a Debian-compatible asset is present.

cd ~/Downloads
sudo apt install ./noteism_*.deb

If apt refuses the package because of distro-specific library differences, fall back to the source build path below instead of forcing it.

There is no official AUR, Flatpak, Fedora RPM, or openSUSE package documented here yet. That is not because we forgot to type the words. It is because the docs only claim channels that are actually live and maintained.

For Arch, Fedora, openSUSE, Nix, and other Linux environments, the honest route today is building from source.

macOS

If the latest release includes a macOS build, download that artifact directly from GitHub releases.

Unsigned build warning

Current macOS builds may be unsigned. Gatekeeper can show the normal first-run warning until signing work is finished.

If you are testing macOS builds:

  • expect occasional rough edges
  • report bugs on GitHub Issues
  • include version, macOS version, and what the app was doing before it broke

Windows

If the latest release includes a Windows build, grab it from the same release page.

Windows builds need more eyes

Windows support is real enough to test, but still benefits from bug reports, regression notes, and plain old “this broke in a weird way” honesty.

Build from source

If you want the freshest behavior, use a distro outside the current package focus, or just prefer to own the toolchain yourself, build from source.

Requirements

  • Rust toolchain
  • Cargo
  • System libraries required by the Rust GUI stack on your platform
  • Optional external tools for some export paths:
    • Pandoc for the broad export pipeline
    • Chromium / Chrome for the preferred rich PDF path
Cargo.toml
src/
themes/
.docs/

Build steps

git clone https://github.com/CLOUDWERX-DEV/Noteism.git
cd Noteism
cargo run

For an optimized binary:

cargo build --release
./target/release/noteism

Source-build notes

  • Release builds are the right choice for realistic performance testing.
  • Theme JSON files in the repo themes/ folder are discovered at runtime.
  • User-imported themes live in your config directory under noteism/themes.
  • The app also persists session/config state under .config/noteism.

After install

Once the app launches, go here next:

  1. Getting Started
  2. Markdown Features
  3. Themes

On this page