https://github.com/seadve/noteworthy

Modern, Fast, and Version-Controlled Markdown Notes App
https://github.com/seadve/noteworthy

gnome gtk gtk4 libadwaita markdown notes rust

Last synced: 30 days ago
JSON representation

Modern, Fast, and Version-Controlled Markdown Notes App

• Host: GitHub
• URL: https://github.com/seadve/noteworthy
• Owner: SeaDve
• License: gpl-3.0
• Created: 2021-08-24T00:38:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-16T23:44:42.000Z (9 months ago)
• Last Synced: 2024-04-27T15:36:37.273Z (7 months ago)
• Topics: gnome, gtk, gtk4, libadwaita, markdown, notes, rust
• Language: Rust
• Homepage:
• Size: 1.21 MB
• Stars: 48
• Watchers: 5
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        


  Noteworthy



Modern, Fast, and Version-Controlled Markdown Notes App




  

    

  

  

    

  



## 0.1.0 Milestone

- [x] Trash and pinning

- [x] Note creation and deletion

- [x] Note metadata

- [x] Powerful tag system

- [x] Filtering

- [x] Basic markdown

- [x] Batch notes selection and editing

- [x] 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](https://github.com/SeaDve/Noteworthy/actions/),

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](https://flathub.org/apps/details/org.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

```shell

meson . _build

ninja -C _build

ninja -C _build install

```