the-notewriter

module
v0.0.0-...-2e1bc12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2024 License: GPL-3.0

README

The NoteWriter

Dependencies

  • SQLite with FTS5 extension + go-sqlite3. SQLite is used to build a database from notes to speed up UI actions and make possible full-text searches.
  • ffmpeg binary (brew install ffmpeg). Used to convert the media files to different formats.

Debug

How to debug a unit test using SQLite?

Define a breakpoint. Inspect the repository root directory. Then:

# On MacOS if the application is installed
$ open -a "DB Browser for SQLite" dirname/.nt/database.db

Check the tables, then close the application and resume the debugging session.

Usage

$ nt init
# Create a new directory .nt with default configuration files
$ cat .nt/config
# ...

# Add some Markdown files
$ nt add . && nt commit

Documentation

Documentation is present in the directory website/. Run make docs to start locally.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL