Skip to content

Modern, Fast, and Version-Controlled Markdown Notes App

License

Notifications You must be signed in to change notification settings

SeaDve/Noteworthy

Repository files navigation

Noteworthy

Modern, Fast, and Version-Controlled Markdown Notes App

CI status Packaging status

0.1.0 Milestone

  • Trash and pinning
  • Note creation and deletion
  • Note metadata
  • Powerful tag system
  • Filtering
  • Basic markdown
  • Batch notes selection and editing
  • Attachments
  • Canvas drawing
  • Syncing (Barely working)
  • Git integration (Barely working)
  • Setup page
  • WYSIWG Editing
  • Homepage (Includes reminders, recents, mini notepads etc.)

Installation Instructions

Noteworthy is under heavy development. Thus, it is currently not recommended to be used for day-to-day tasks. However, it is possible to download the nightly build artifact from the Actions page, then install it locally by running flatpak install noteworthy.flatpak.

Build Instructions

GNOME Builder

GNOME Builder is the environment used for developing this application. It can use Flatpak manifests to create a consistent building and running environment cross-distro. Thus, it is highly recommended you use it.

  1. Download GNOME Builder.
  2. In Builder, click the "Clone Repository" button at the bottom, using https://github.com/SeaDve/Noteworthy.git as the URL.
  3. Click the build button at the top once the project is loaded.

Meson

Prerequisites

The following packages are required to build Noteworthy:

  • meson
  • ninja
  • appstream-glib (for checks)
  • cargo
  • gstreamer
  • gstreamer-plugins-base
  • glib2
  • gtk4
  • gtksourceview5
  • libadwaita

Build Instructions

meson . _build
ninja -C _build
ninja -C _build install

About

Modern, Fast, and Version-Controlled Markdown Notes App

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages