rnote/README.md

31 lines
769 B
Markdown
Raw Normal View History

2020-11-24 19:13:52 +01:00
# rnote
[![license](https://img.shields.io/badge/licence-GPLv3-blue)](https://framagit.org/fiplox/rpass/-/blob/main/LICENSE)
A minimal note taking cli tool.
## Description
2020-11-27 14:39:02 +01:00
**rnote** creates `Markdown` text files in a date-named or category directories with a name of a header of the note.
2020-11-24 19:13:52 +01:00
2020-11-27 14:39:02 +01:00
Example:
2020-11-24 19:13:52 +01:00
```
.rnote/
├── 2020-03-20
2020-11-27 14:39:02 +01:00
│   └── Lockdown.md
├── 2020-10-20
│   └── New Lockdown.md
└── shop
└── to buy.md
2020-11-24 19:13:52 +01:00
```
## TODO
2020-11-27 22:21:23 +01:00
- [x] Create a note
- [x] Delete a note
- [x] Modify a note
2020-11-27 14:39:02 +01:00
- [ ] Show all notes in a scrollable TextView in a raw terminal with [termimad](https://crates.io/crates/termimad)
- [ ] Show all notes from `DATE` or `Category`
2020-11-27 22:21:23 +01:00
- [x] Search a note by header
2020-11-27 23:24:20 +01:00
- [x] Search a note by word (kinda grep)