add readme

This commit is contained in:
sigil-03 2024-07-11 13:34:40 -06:00
parent 0eb20e88d7
commit f3b9a1f8d2

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# prusatool-rs
`prusatool-rs` is a simple utility to print `.bgcode` files from the command line.
# Usage
## Loading
`prusatool --printer-config <CONFIG_FILE> load <.bgcode FILE> --print-immediately`
The optional `--print-immediately` flag tells the printer to start printing the file immediately.
## Running
If `--print-immediately` wasn't used, or you'd like to print a file that already exists on the printer's filesystem, you can print a file by using the `print` command, with the file's UUID:
`prusatool --printer-config ~/printer_config_template.toml print <FILE UUID>`