chore: update docs, rename to "ldr"
This commit is contained in:
6 files changed
+57
-35
No files matched your search
@@ -1,13 +1,31 @@
|
||||
# PARTS - Prepend and Review ToDo System
|
||||
# LDR - Log, Do, Review
|
||||
|
||||
A simple command-line productivity system that lets you add items to the top of your list and review them interactively.
|
||||
A simple command-line productivity system that lets you add items to the top of
|
||||
your list and review them interactively.
|
||||
|
||||
## Inspiration
|
||||
|
||||
This tool was inspired by Andrej Karpathy's blog post ["The append-and-review note"](https://karpathy.bearblog.dev/the-append-and-review-note/), which describes a simple but effective productivity system using a single text file where you append new items to the top and periodically review from the top down.
|
||||
This tool was inspired by Andrej Karpathy's blog post ["The append-and-review
|
||||
note"](https://karpathy.bearblog.dev/the-append-and-review-note/), which
|
||||
describes a simple but effective productivity system using a single text file
|
||||
where you append new items to the top and periodically review from the top down.
|
||||
|
||||
## Installation
|
||||
|
||||
### From crates.io
|
||||
|
||||
```bash
|
||||
cargo install ldr
|
||||
```
|
||||
|
||||
### Using mise
|
||||
|
||||
```bash
|
||||
mise use -g cargo:ldr
|
||||
```
|
||||
|
||||
### From source
|
||||
|
||||
1. Clone this repository
|
||||
2. Build with Cargo:
|
||||
|
||||
@@ -18,17 +36,17 @@ This tool was inspired by Andrej Karpathy's blog post ["The append-and-review no
|
||||
3. Copy the binary to your PATH:
|
||||
|
||||
```bash
|
||||
cp target/release/parts ~/.local/bin/
|
||||
cp target/release/ldr ~/.local/bin/
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
- `parts add "Your todo item"` - Add a new item to the top
|
||||
- `parts ls` - List your items
|
||||
- `parts scan` - Review items interactively
|
||||
- `parts do 1 2 3` - Archive completed items by number
|
||||
- `parts up 1 2 3` - Prioritize items by moving them to the top
|
||||
- `parts edit` - Edit your todo list in $EDITOR
|
||||
- `ldr add "Your todo item"` - Add a new item to the top
|
||||
- `ldr ls` - List your items
|
||||
- `ldr scan` - Review items interactively
|
||||
- `ldr do 1 2 3` - Archive completed items by number
|
||||
- `ldr up 1 2 3` - Prioritize items by moving them to the top
|
||||
- `ldr edit` - Edit your todo list in $EDITOR
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in new issue
Block a user