Tp-Note - fast note-taking with templates and filename synchronization


Table of Contents

Documentation
Source code
Distribution
Upgrading
Building and installing
About

Tp-Note is a note-taking-tool and a template system - freely available for Windows, MacOS and Linux - that consistently synchronizes the note’s meta-data with its filename. Tp-Note collects various information about its environment and the clipboard and stores them in variables. New notes are created by filling these variables in predefined and customizable Tera-templates. TP-Note’s default templates are written in Markdown and can be easily adapted to any other markup language if needed. By default TP-Note launches the system file-editor (or any other of your choice, e.g. Typora) after creating a new note.

Documentation

User documentation:

Developer documentation:

Source code

Repository:

Distribution

Upgrading

When you install a new version of Tp-Note, please delete the old configuration file, that is automatically written in

  • Linux: ~/.config/tp-note/tp-note.toml

  • Windows: C:\Users\<LOGIN>\AppData\Roaming\tp-note\config\tp-note.toml

The reason is, that the structure of the configuration file might change from version to version. For example, new configuration variables might be added: When Tp-Note starts, it reads the old configuration and will complain about a malformed structure. I recommend deleting the old configuration file, even when there is no error message: new template-variables might activate new features, that will only be available, when Tp-Note starts with a fresh default template.

There is no need to say, that in case you modified the configuration file, you should backup it before deleting.

Building and installing

  1. Install Rust, e.g.

    curl https://sh.rustup.rs -sSf | sh
    
  2. Download, compile and install Tp-Note:

    sudo apt-get install -y xorg-dev libxcb-xfixes0-dev libxcb-shape0-dev libgtk-3-dev
    cargo install tp-note
    sudo cp ~/.cargo/bin/tp-note /usr/local/bin
    

    See also the user manual for a detailed installation description.

This project follows Semantic Versioning.

About

Author:

  • Jens Getreu

Copyright:

  • Apache 2 licence or MIT licence