71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
# CatNote
|
||
|
||
CatNote is a minimalist web application that lets you generate Markdown-based receipts or notes, render them as PNGs, and send them directly to an MXW01 Cat Thermal Printer. Ideal for making quick, beautiful, and portable printed notes using Markdown, with optional image upload.
|
||
|
||
## Features
|
||
|
||
* Enter Markdown and preview output.
|
||
* Supports bold, italic, headings, lists, images (by URL or upload), and dividers.
|
||
* Upload a PNG/JPG image and embed it in your printout.
|
||
* One-click print: output to Cat Printer or download the PNG.
|
||
* Clean, mobile-friendly UI.
|
||
|
||
## Requirements
|
||
|
||
* Python 3.8+
|
||
* Flask
|
||
* Pillow (PIL)
|
||
* `bleh` v1.0.0 or later (see below)
|
||
|
||
## Installation
|
||
|
||
1. **Clone this repository**
|
||
|
||
```sh
|
||
git clone <your-catnote-repo-url>
|
||
cd catnote
|
||
```
|
||
|
||
2. **Install Python dependencies (instructions for a venv)**
|
||
|
||
```sh
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
3. **Obtain the `bleh` binary**
|
||
|
||
This app does **not** include the `bleh` printer driver binary for licensing reasons.
|
||
You must build or download it yourself from [git.netpaws.cc/igna/bleh](https://git.netpaws.cc/igna/bleh).
|
||
|
||
It's easiest to just get the latest release via wget:
|
||
|
||
```
|
||
wget -O ./bleh https://git.netpaws.cc/igna/bleh/releases/download/latest/bleh
|
||
```
|
||
|
||
Place the built `bleh` binary in the app root directory (next to `app.py`).
|
||
|
||
4. **Run CatNote**
|
||
|
||
```sh
|
||
python app.py [--port 1234]
|
||
```
|
||
|
||
By default, it listens on port 5000. Access it via `http://localhost:5000/`.
|
||
|
||
___Warning:___ This application listens on your local network, don't expose its port to the Internet!
|
||
|
||
## Usage
|
||
|
||
* Paste or write your Markdown in the main text box.
|
||
* (Optional) Upload an image to embed it.
|
||
* Click **Generar** for a preview, or **Imprimir** to send to your Cat Printer.
|
||
|
||
## License
|
||
|
||
This project is licensed under the terms of the GNU General Public License v3.0 or later. See [COPYING](./COPYING) for details.
|
||
|
||
The Ubuntu Font is licensed under the Ubuntu Font Licence 1.0. See [UFL.txt](./fonts/ubuntu/UFL.txt) for details.
|
||
|
||
> Disclaimer: While a license was only added after the project’s initial commits, the current license applies retroactively to all previous commits of this repository.
|