From 3762a82bab12fd77cf0a079a77140b3d54037ae7 Mon Sep 17 00:00:00 2001 From: randogoth Date: Tue, 13 Oct 2026 12:13:29 +0300 Subject: [PATCH] docs: bump version to 1.1.0 and document the editor, shortcuts and D-pad --- README.md | 27 +++++++++++++++++---------- lib/texts.dart | 45 +++++++++++++++++++++++++++++++++++++++++++-- pubspec.yaml | 4 ++-- 3 files changed, 62 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a873cb8..0d246eb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ -# muzzlevelocity +# Muzzle Velocity -A new Flutter project. +A fast and minimalist note-taking app inspired by *Notational Velocity* and *Terminal Velocity*. Notes are plain Markdown files in a folder you choose, so you can sync or edit them with other tools. -## Getting Started +- One search bar to filter notes by title, content, and `#tags`, `+projects`, or `@contexts`, and to create a note by pressing Enter. +- Notes open read-only with Markdown highlighting, and jump to the search match. Switch to editing with one tap. +- Editing helps with Markdown: wrapping selections, continuing lists, and keeping indentation. +- Keyboard shortcuts on desktop and D-pad navigation on phones. -This project is a starting point for a Flutter application. +The in-app Help page (`:help` or the menu) describes every feature. -A few resources to get you started if this is your first Flutter project: +## Development -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +The toolchain (Flutter, JDK, Android SDK, and Linux build tools) is managed with [devbox](https://www.jetify.com/devbox): -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +```sh +devbox run test # Run the tests. +devbox run analyze # Run static analysis. +devbox run run # Run on a connected device. +devbox run run-linux # Run the Linux desktop app. +``` + +The devbox-managed Android SDK is read-only and provides NDK 27.0.12077973, so the Android build pins that version instead of Flutter's default. diff --git a/lib/texts.dart b/lib/texts.dart index ed65a52..18abdd1 100644 --- a/lib/texts.dart +++ b/lib/texts.dart @@ -18,11 +18,52 @@ Swipe a note in the list to the left to move it to the trash. The trash is a directory in the root folder. Use :emptytrash or the context menu button to permanently clear deleted notes. -# Edit Notes +# Read and Edit Notes + +Notes open read-only. Tap the pencil at the top to start editing, and tap it again to stop. +If you searched for something, the note opens at the first match. Use the arrow buttons at the bottom right to jump between matches. +*Preview Mode* in the menu shows the rendered Markdown. + +While editing: +- Select text and type * _ ` ~ [ or ( to wrap it. +- Press Enter in a list to continue it with the next bullet, number, or checkbox. Press Enter on an empty item to end the list. +- New lines keep the indentation of the previous line. Enable/disable autosave in the menu. When disabled you can use the Save button in the menu. If there are unsaved changes when you are leaving the editor, you will be prompted to save. +# Keyboard Shortcuts + +On a Mac, use Cmd instead of Ctrl. + +In the note list: +- Up/Down – Pick a note, Enter – Open it. +- Ctrl+L – Go to the search bar. +- Ctrl+T – Show/hide tags. + +In a note: +- Ctrl+E – Start/stop editing. +- Ctrl+S – Save. +- Ctrl+P – Preview Mode. +- Ctrl+B / Ctrl+I – Bold / italic. +- F3 or Ctrl+G – Next match, Shift+F3 or Ctrl+Shift+G – Previous match. +- Ctrl+= / Ctrl+- / Ctrl+0 – Bigger / smaller / default font size. +- Up/Down and Page Up/Down – Scroll while reading. +- Tab / Shift+Tab – Indent / outdent lines while editing. +- Esc / Ctrl+L – Back to the list. + +Anywhere: +- Ctrl+D – Switch between light and dark themes. +- Ctrl+Q – Quit. + +# D-pad + +On phones with a D-pad: +- Down in the search bar moves to the list, Up and Down pick a note, and Center opens it. +- Left goes back to the search bar from the list, or back to the list from a note. +- Right clears the search bar, or opens the menu. Use Up/Down and Center in the menu. +- Up/Down scroll a note. Hold Center to go back to the list. + # Tag Notes Use tags anywhere in the notes and they will be detected. @@ -67,7 +108,7 @@ Use commands by starting with a colon : """; String aboutContent = """ -v.1.0.2 +v.1.1.0 **Muzzle Velocity** is a fast and minimalist but opinionated note-taking app inspired by the legendary *Notational Velocity* on MacOS and *Terminal Velocity* for command line terminals. diff --git a/pubspec.yaml b/pubspec.yaml index 39e2887..cd17eb9 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,7 @@ name: muzzle_velocity -description: "A new Flutter project." +description: "A fast, minimalist note-taking app inspired by Notational Velocity." publish_to: 'none' # Remove this line if you wish to publish to pub.dev -version: 1.0.0+1 +version: 1.1.0+2 environment: sdk: ^3.6.0