Updated Using Tuhi (markdown)

master
Peter Hutterer 2019-08-22 16:38:41 +10:00
parent ccced2d82f
commit e31fd3b8fc
1 changed files with 24 additions and 14 deletions

@ -1,31 +1,41 @@
A few notes on the Tuhi GUI.
## Tuhi defaults to the first device
<img src="https://raw.githubusercontent.com/tuhiproject/tuhi/screenshots/main-window.png" width="50%" align="right" alt="A screenshot of the main window">
Tuhi GUI only supports a single device. Where multiple devices are present, it will simply pick the first one it finds. Unless you have more than one device, this is not an issue.
# Tuhi Manual
Tuhi has a simple interface with a single goal: make it easy to download the drawings to the host computer for future editing with other programs. Tuhi displays all drawings in reverse chronological order (newest first), grouped by month (see the screenshot to the right).
Tuhi automatically downloads any drawings from the device when connected. To initialize a connection, press the button on the device while Tuhi is running.
**WARNING: Drawings get deleted from the device after downloading.** This is an inherent functionality of the device firmware.
## Registering a device
When Tuhi first opens with no device [[registered|Terminology]], it will start the registration process. Follow the instructions which basically consist of: press and hold the button for 6 seconds until the blue light flashes. Then press the button again when prompted.
## Downloading drawings
## Rotating, saving and deleting a drawing
Tuhi will automatically download any drawings from the device when connected. To initialize a connection, press the button on the device while Tuhi is running.
On mouse-over on any drawing, Tuhi displays the possible actions for this drawing.
**WARNING: Drawings get deleted from the device after downloading.** This appears to be an inherent functionality of the device firmware.
<img src="https://raw.githubusercontent.com/tuhiproject/tuhi/screenshots/drawing-buttons.png" width="30%" align="left" alt="The buttons to interact">
## Manipulating drawings
The left-most buttons rotate this single drawing 90 degree steps counter-clockwise or clockwise. The second button from the right is the save button, clicking it will open a standard "save as" dialog. Use this to download the file from Tuhi for further processing.
Drawings can only be rotated. Use the buttons above the drawings to rotate left or right, or the hamburger menu to change the orientation of the tablet permanently.
## Saving drawings
<img src="https://raw.githubusercontent.com/tuhiproject/tuhi/screenshots/undo-delete.png" width="30%" alt="the Undo delete dialog" align="right">
Use the "save as" button above each drawing to save it to the file system.
The right-most button is the delete button. Unless deleted, the drawing will stay around forever but you **really** don't want to rely on Tuhi as a backup system for your precious drawings. Where a file got accidentally deleted, use the "Undo" button that shows up immediately after deleting a file.
## Deleting drawings
## Zooming and battery state
Use the delete button above each drawing to delete it. Unless deleted, the drawing will stay around forever but you **really** don't want to rely on Tuhi as a backup system for your precious drawings.
<img src="https://raw.githubusercontent.com/tuhiproject/tuhi/screenshots/battery-state.png" width="30%" alt="the zoom slider and battery icon" align="right">
## Zooming
Moving the zoom slider in the top right of the window bar enlarges the thumbnails where needed. This has no effect on the actual drawings which are always in device units, it merely affects the display of those in the Tuhi GUI.
There is a zoom slider inside the window bar, use that to enlarge the thumbnails where needed. This has no effect on the actual drawings which are always in device units.
Next to the zoom slider is an icon displaying the battery state of the device. Hovering above this icon will display the battery charge percentage, the icon itself just displays a rough approximation of the charge state.
## Changing the orientation of the device
<img src="https://raw.githubusercontent.com/tuhiproject/tuhi/screenshots/drop-down-menu.png" width="20%" alt="the drop-down menu" align="left">
The drop-down menu shown when you click the hamburger button allows switching between portrait and landscape mode. This is a permanent setting, Tuhi remembers it across restarts. All current and future drawings default to that orientation. You can still rotate individual drawings with the buttons above the drawing itself.