Skip to content

Commit b3a4337

Browse files
committed
Update readme
1 parent 29f5e43 commit b3a4337

File tree

3 files changed

+25
-8
lines changed

3 files changed

+25
-8
lines changed

Diff for: README.md

+24-7
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,23 @@
22

33
GUI which displays HDR images, no bullshit.
44

5+
![Screenshots](/media/Screenshots.png?raw=true)
6+
57
## Features
68

79
* Opens popular HDR image formats: Radiance PIC (_*.pic, *.hdr_), PFM (_*.pfm, *.ppm_), OpenEXR (_*.exr_)
810
* Exports images in Radiance PIC or PFM format
911
* Fast zoom, pan and brightness control
10-
* Manage multiple documents in tabs
12+
* Manage multiple image documents in tabs
13+
* Compare opened images (absolute difference or side-by-side)
1114

1215
## Build
1316

1417
* Install Qt 5.5
1518
* Download [boost](http://www.boost.org/) (headers are sufficient, no need to build)
1619
* Clone the repository from `https://github.com/Acly/hdrv.git`
1720

18-
### Windows
21+
### Windows - VC14
1922
```
2023
mkdir build
2124
cd build
@@ -25,7 +28,7 @@ qmake -tp vc ../hdrv.pro "BOOST_ROOT=/path/to/boost"
2528
This generates a project file which can be used to build the application with Visual Studio.
2629
After building, runtime libraries can be copied with `windeployqt --qmldir ../src/view release/hdrv.exe`.
2730

28-
Tested using Visual Studio 2015 Update 1 x64.
31+
Tested using Visual Studio 2015 Update 2 x64.
2932

3033
### Other Platforms
3134

@@ -39,12 +42,26 @@ Entirely untested, but there is no platform-dependent code or anything else any
3942

4043
## Use
4144

42-
It's a self-explanatory and intuitive GUI. Duh.
45+
Load images by supplying them as arguments to the hdrv executable, drag-and-drop them into the viewer or
46+
use the _Open image_ button in the tab bar.
47+
48+
### Mouse controls
49+
50+
* \[ **Pan** \] Hold the left mouse button to view different regions of the image if it does not fit on the screen.
51+
* \[ **Zoom** \] Use the mouse wheel to scale the image.
52+
* \[ **Compare** \] Hold the right mouse button in comparison mode to move the image comparison separator.
53+
54+
### Keybaord shortcuts
55+
56+
* \[ **+**/**-** \] Increase / decrease the image brightness.
57+
* \[ **Left**/**Right** \] Iterate through images in the current folder.
58+
* \[ **1**/**2**/**3**/... \] Switch to image tab 1, 2, 3, ...
59+
* \[ **S** \] Toggle between the last two image tabs.
60+
* \[ **C** \] Open comparison mode for the last two images.
61+
* \[ **R** \] Reset positioning and scaling of the image.
4362

4463
## TODO
4564

46-
* Show current pixel location and color under cursor
4765
* Show more stats (average / maximum / minimum color)
48-
* Better tone mapping
66+
* Hight quality tone mapping
4967
* Better support for existing formats (encodings, layouts)
50-
* Image comparison tools

Diff for: media/Screenshots.png

436 KB
Loading

Diff for: src/view/Main.qml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ApplicationWindow {
1010
height: 800
1111
visible: true
1212
color: 'black'
13-
title: images.current.name + ' - hdrv 0.2'
13+
title: images.current.name + ' - hdrv 0.3'
1414

1515
function loadNextFile(prev) {
1616
var url = images.nextFile(prev);

0 commit comments

Comments
 (0)