Add license and Readme

This commit is contained in:
2023-09-23 16:02:56 +02:00
parent 55896d74f9
commit b55681752d
3 changed files with 55 additions and 4 deletions

51
README.md Normal file
View File

@@ -0,0 +1,51 @@
# ptprnt
This is a rewrite of [ptouch-print](https://git.familie-radermacher.ch/linux/ptouch-print.git) as a toy project for my personal amusement. The currently available solutions are good enough for generating labels, but i wanted to explore libusb and maybe improve the functionality of my label printer. All credits for reverse engineering the USB commands to Dominic Rademacher.
## Dependencies
This project requires:
- spdlog
- libusb
- pango
- cairo
- meson
- gtest (optional, for testing, will be installed by meson)
- gcov (optional, for coverage reports)
## Build
Clone the repository and simply let meson do the heavy lifting.
```bash
meson setup builddir
```
If you want to generate coverage reports, enable them via the command line switch
```bash
meson setup builddir -Db_coverage=true
```
Rebuild by simply invoking ninja
```bash
ninja -C builddir
```
## Run
Run the binary from your builddir
```bash
builddir/ptprnt
```
## Test
Testing is done via gtest. To run your test simply invoke ninja with the "test" target.
```bash
ninja -C builddir test
```
Coverage reports can be generated via gcov if you enabled them (see Build section) by building the `coverage-text` target.
## License
GPLv3, see [LICENSE](./LICENSE)
## Author
Moritz Martinius <moritz@admiralackbar.de>