Skip to content

Commit

Permalink
Instructions for installation and usage in README
Browse files Browse the repository at this point in the history
  • Loading branch information
kaloyan-raev authored Dec 8, 2017
1 parent 1d59f07 commit ab11ea0
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# fread.ink print screen tool

A tool for printing text and graphics to the eink display. The image data is printed directly to the display's framebuffer.

## Installation

1. Download the `fips` executable from the [latest release](https://github.com/fread-ink/fread-fips/releases/latest). It is compiled for the fread.ink firmware.
1. Copy the `fips` executable to the device, e.g. via [USB networking](https://github.com/fread-ink/fread-vagrant#enabling-usb-networking).

## Usage

### Display an image

`./fips -g image_path [-f]`

where:
- _-g_ is the parameter for displaying a PNG image
- _image_path_ is the path to the image's file
- _-f_ is an optional parameter for making a full update of the display, the default is partial update

### Clear the display

`./fips -c`

where:
- _-c_ is the parameter for clearing the display

0 comments on commit ab11ea0

Please sign in to comment.