real_time_note_taker 0.1.2

A terminal UI tool to track meeting cost in real time based on employee salaries.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# Real Time Note Taker
[![Crates.io](https://img.shields.io/crates/v/rtnt.svg)](https://crates.io/crates/rtnt)
[![Documentation](https://docs.rs/rtnt/badge.svg)](https://docs.rs/rtnt)
[![CI](https://github.com/Data-Forge-Solutions/real_time_note_taker/actions/workflows/CI.yml/badge.svg)](https://github.com/Data-Forge-Solutions/real_time_note_taker/actions)
[![License](https://img.shields.io/crates/l/rtnt)](LICENSE)
[![GitHub](https://img.shields.io/github/stars/Data-Forge-Solutions/real_time_note_taker?style=social)](https://github.com/Data-Forge-Solutions/real_time_note_taker)

**RTNT** is a terminal user interface for taking timestamped notes. Notes can be organized into titled sections and exported to CSV for further processing. All active key bindings are always visible at the bottom of the UI.

![Demo of RTNT](readme_resources/demo.gif)

## Features

- Millisecond accurate timestamps
- Section markers to organize discussions
- Edit existing entries
- Save and load notes from CSV
- Fully keyboard driven with customizable bindings

## Installation

Add the binary with Cargo once the crate is published:

```bash
cargo install real_time_note_taker
```

## Running

```bash
cargo run --release
```

### Automatic file mode

Passing `--file <PATH>` will load notes from the given file and save them back on exit.

### Custom key bindings

Press the key shown as `Keys` in the help line to open the binding menu. Use the arrow keys to select an action and press <kbd>Enter</kbd> to assign a new key. Bindings are stored in `keybindings.json` inside the configuration directory (typically `~/.config/rtnt`).

## Library Usage

```rust
use real_time_note_taker::{run, App};

fn main() -> std::io::Result<()> {
    let app = App::new();
    let _app = run(app)?;
    Ok(())
}
```

## Saving location

Files are written to [`App::default_save_dir`] which resolves to a platform appropriate directory and is created on first use.

## License

This project is licensed under the MIT or Apache-2.0 licenses at your option.