Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
__pycache__/
*.py[cod]
*$py.class
.mypy_cache/

# Distribution / packaging
build/
Expand Down
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ A terminal-based post-it notes application — organize your thoughts in a 3×3
![Python](https://img.shields.io/badge/Python-3.9%2B-blue)
![License](https://img.shields.io/badge/License-MIT-green)

![tui-notes demo](docs/demo.gif)

## Features

- **3×3 Post-it Grid** — Up to 9 notes displayed simultaneously
Expand All @@ -17,13 +19,19 @@ A terminal-based post-it notes application — organize your thoughts in a 3×3
## Installation

```bash
# Clone and install
git clone https://github.com/douglas/tui-notes.git
# Recommended for CLI tools (isolated environment, globally available)
pipx install tui-notes

# Or with pip in a virtual environment
pip install tui-notes
```

### From source

```bash
git clone https://github.com/Douglas019BR/tui-notes.git
cd tui-notes
pip install -e .

# Or with pipx (recommended for CLI tools)
pipx install .
```

## Usage
Expand Down Expand Up @@ -87,4 +95,4 @@ pylint tui_notes/

## License

MIT — see [LICENSE](LICENSE) file.
[MIT - LICENSE](LICENSE)
Binary file added docs/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.