tami/brother_ql_web
6
0
Fork 0
mirror of https://github.com/pklaus/brother_ql_web.git synced 2024-05-25 11:56:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

README: new Usage section (including info previously in introduction)

Browse Source
This commit is contained in:
Philipp Klaus 2018-01-28 12:48:24 +01:00
parent 8b76bc137e
commit 4f8fedc184
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,11 +2,6 @@
This is a web service to print labels on Brother QL label printers. This is a web service to print labels on Brother QL label printers.
It offers:
* a Web GUI allowing you to print your labels at */labeldesigner*,
* an API at */api/print/text/Your_Text?font_size=100&font_family=Minion%20Pro&font_style=Semibold*
to print a label containing 'Your Text' with the specified font properties.
You need Python 3 for this software to work. You need Python 3 for this software to work.
### Installation ### Installation
@ -54,3 +49,16 @@ To start the server, run `./brother_ql_web.py`. Here's its command line interfac
--model {QL-500,QL-550,QL-560,QL-570,QL-580N,QL-650TD,QL-700,QL-710W,QL-720NW,QL-1050,QL-1060N} --model {QL-500,QL-550,QL-560,QL-570,QL-580N,QL-650TD,QL-700,QL-710W,QL-720NW,QL-1050,QL-1060N}
The model of your printer (default: QL-500) The model of your printer (default: QL-500)
### Usage
Once it's running, access the web interface by opening the page with your browser.
If you run it on your local machine, go to <http://localhost:8013> (You can change
the default port 8013 using the --port argument).
You will then be forwarded by default to the interactive web gui located at */labeldesigner*.
All in all, the web server offers:
* a Web GUI allowing you to print your labels at */labeldesigner*,
* an API at */api/print/text/Your_Text?font_size=100&font_family=Minion%20Pro&font_style=Semibold*
to print a label containing 'Your Text' with the specified font properties.