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 with rustup:

   curl https://sh.rustup.rs -sSf | sh

   The fast-track procedure:

   cargo install tp-note sudo cp ~/.cargo/bin/tp-note /usr/local/bin

   If it works for you, you are done. Otherwise continue the next step.

2. Download tp-note:

   git clone git@github.com:getreu/tp-note.git

3. Build:

   Enter the tp-note directory where the file Cargo.toml resides:

   cd tp-note

   Then execute:

   cargo build --release ./doc/make--all

4. Install:

   a. Linux:

      # install binary
      sudo cp target/release/tp-note /usr/local/bin/
   
      # install man-page
      sudo cp man/tp-note.1.gz /usr/local/man/man1/
      sudo dpkg-reconfigure man-db   # e.g. Debian, Ubuntu
   

   b. Windows:

   Copy the binary target/release/tp-note.exe on your desktop.

   See the user manual for a detailed installation description.

This project follows Semantic Versioning.

About

Author:

• Jens Getreu

Copyright:

• Apache 2 licence or MIT licence