Update the quick start guides
Some checks failed
Build / Initialization (push) Has been cancelled
Build / Code Format Validation (push) Has been cancelled
Build / Linux (Qt6) (push) Has been cancelled
Build / Linux (Qt6 + 7zip) (push) Has been cancelled
Build / macOS (Qt6 Universal) (push) Has been cancelled
Build / Windows x64 (Qt6) (push) Has been cancelled
Build / Windows ARM64 (Qt6) (push) Has been cancelled
Build / Docker amd64 Image (push) Has been cancelled
Build / Docker arm64 Image (push) Has been cancelled
Build / Publish Dev Builds (push) Has been cancelled
Build / Publish Release (push) Has been cancelled
Build / Publish YACReader10 Pre-release Builds (push) Has been cancelled

It isn't much but it's way better than the old ones.
This commit is contained in:
luisangelsm
2026-04-10 23:09:45 +02:00
parent 78574aaf02
commit 94514cf9f8
4 changed files with 226 additions and 422 deletions

View File

@ -1,145 +1,69 @@
<html>
<html>
<head>
<style type="text/css">
h1, h2{
h1, h2 {
color: #302f2d;
font-weight: normal;
font-weight: normal;
}
h1{
font-size: 20px;
h1 {
font-size: 20px;
}
h2{
font-size: 14px;
h2 {
font-size: 14px;
}
a {
color: #C19441;
}
}
li {
margin-bottom: 6px;
}
</style>
</head>
<body>
<h1>Quick start guide</h1>
<p> This guide is outdated, get more help on <a href="http://www.yacreader.com">http://www.yacreader.com</a> </p>
<h2>Features</h2>
<p>
YACReader is a fast and simple comic reader with the following features:
<ul>
<li>Multiplatform, there are Windows, Linux and MacOS X versions.</li>
<li>cbr, cbz, rar, zip, tar and folders support</li>
<li>jpeg, gif, png, tiff and bmp image support</li>
<li>comic reading using keyboard and mouse</li>
<li>fast open and comic navigation</li>
<li>fullscreen mode</li>
<li>configurable magnifying glass for improved reading, since 0.2.0 version is available in windowed mode</li>
<li>fit width (also adjust to an specific width) and fit height modes.</li>
<li>configurable CoverFlow like effect for "go to page" function.</li>
<li>image rotation for comfortable reading even in tablet PCs</li>
<li>double page reading</li>
<li>Comic bookmarks</li>
</ul>
</p>
<h2>Functions and sortcuts</h2>
<p>
<b>General functions:</b>
<ul>
<li><img src=":/images/helpImages/open.png" align="middle"/>Open comic : 'O' key</li>
<li><img src=":/images/helpImages/openFolder.png" align="middle"/>Open folder : 'Ctrl' + 'O' key</li>
<li><img src=":/images/helpImages/nextComic.png" align="middle"/> Open next cómic : 'Ctrl' + 'Right'</li>
<li><img src=":/images/helpImages/previousComic.png" align="middle"/> Open previous comic : 'Ctrl' + 'Left' key</li>
<li><img src=":/images/helpImages/deleteLibrary.png" align="middle"/> Exit : 'Esc' key</li>
<li><img src=":/images/helpImages/prev.png" align="middle"/> Go to previous page : 'Left' key</li>
<li><img src=":/images/helpImages/next.png" align="middle"/>Go to next page : 'Right' key</li>
<li><img src=":/images/helpImages/mouse.png" align="middle"/>Scroll up : 'Wheel mouse up' or 'Up' key </li>
<li><img src=":/images/helpImages/mouse.png" align="middle"/>Scroll down : 'Wheel mouse down' or 'Down' key </li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Auto Scroll down : 'Space Bar'</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Auto Scroll up : 'B' key</li>
<li><img src=":/images/helpImages/rotateL.png" align="middle"/>Rotate to the left : 'L' key</li>
<li><img src=":/images/helpImages/rotateR.png" align="middle"/>Rotate to the rigth : 'R' key</li>
<li><img src=":/images/helpImages/goto.png" align="middle"/>Open "Go to" dialog : 'G' key</li>
<li><img src=":/images/helpImages/fit.png" align="middle"/>Change between fit width/height modes : 'A' key</li>
<li><img src=":/images/helpImages/doublePage.png" align="middle"/>Double page mode : 'D' key</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Toggle Full Screen mode : 'F' key or double click</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>For "Go to flow" mode aproximate mouse cursor to bottom border or press 'S' key (show/hide switch).</li>
<li><img src=":/images/helpImages/zoom.png" align="middle"/>Show magnifying glass (only in fullscreen mode) : 'Z' key</li>
<li><img src=":/images/helpImages/options.png" align="middle"/>Show options : 'C' key</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Show/hide tool bar : 'H' key</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Show information ("current page/number of pages - current time"): 'I' key</li>
<li><img src=":/images/helpImages/bookmark.png" align="middle"/>Show bookmarks dialog : 'M' key</li>
<li><img src=":/images/helpImages/setBookmark.png" align="middle"/>Set bookmark: 'Ctrl' + 'M' key</li>
</ul>
</p>
<p>
<b>"Go to flow" functions:</b>
<ul>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Hide / show : 'S' key.</li>
<!--<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Center page : 'Space Bar'</li>-->
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Go to current central page on the flow : 'Return' or 'Enter' </li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Next flow page : 'Right' key or left mouse click on the right area of the flow</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Previous flow page : 'Left' key or left mouse click on the left area of the flow</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Fast forward : 'Ctrl' + 'Right'</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Fast backward : 'Ctrl' + 'Left'</li>
<li><img src=":/images/helpImages/mouse.png" align="middle"/>Scroll flow : Wheel mouse</li>
</ul>
</p>
<p>
<b>Magnifying glass functions:</b>
<ul>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/>Show/hide : 'Z' key.</li>
<li><img src=":/images/helpImages/mouse.png" align="middle"/>Resize : Wheel mouse or '+'/'-' keys.</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/><img src=":/images/helpImages/mouse.png" align="middle"/>Resize height : 'Ctrl' + Wheel mouse.</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/><img src=":/images/helpImages/mouse.png" align="middle"/>Resize width : 'Alt' + Wheel mouse.</li>
<li><img src=":/images/helpImages/keyboard.png" align="middle"/><img src=":/images/helpImages/mouse.png" align="middle"/>Adjust zoom level : 'Shift' + Wheel mouse or 'Shift' + '+'/'-' keys.</li>
</ul>
</p>
<p>
<b>Configuration dialog</b>
<ul>
<li>"My comics path" : set your favourite comic path. Open comic dialog will open that path by default.</li>
<li>"Go to flow size" : move the slider to set your preferred go to flow size </li>
<li>"How to show pages in GoToFlow" : since version 0.2.0, you can choose between three diferent styles:
<ul>
<li> Cover Flow : the classic style</li>
<li> Strip : a strip of pages flowing horizontaly </li>
<li> Overlapped Strip : a strip of pages with overlap effect </li>
<ul>
</li>
<li>"Page width stretch" : move the slider to set your preferred page width stretch. This takes effect in "fit to width" reading mode.</li>
</ul>
</p>
<p>
<b>Bookmarks</b>
<ul>
<li>You can add three bookmarks per comic (using thumbtack icon or pressing 'Ctrl'+M). New bookmarks replace oldest bookmarks.</li>
<li>YACReader saves automatically the latest page read (the current page when closing).</li>
<li>To go to any bookmark (last page included), open de bookmarks dialog and click on the desired page</li>
</ul>
</p>
<h2>Usage and considerations</h2>
<p>
The usual way to read a comic with YACReader is press 'O' to open a comic,
and then use 'Space' and 'B' for autoscrolling pages, you can use 'UP', 'DOWN' or
'Mouse Wheel' too, when you reach page limit (top or bottom) next page is loaded
automatically, moreover, you can go to next or previous page using 'RIGTH' and 'LEFT'.
</p>
<p>
Jumping between pages is possible using "Go To..." dialog ('G' key) or "Go To Flow" widget ('S' key).
You don't have to wait until all pages are loaded to use these functions, because pages are shown as soon
as they are ready.
</p>
<p>
YACReader loads all comic compresed images in memory, when it needs to show one page, only that one is rendered.
Since all pages are in memory YACReader uses aproximately the same RAM as the comic size, so take care if you want to view huge
comics with YACReader (comics larger than your RAM).
</p>
<p>
The "Go To flow" widget needs to render only the images which will be shown,
doing it in a lazy way to reduce memory consumption, in any case,
it takes a significant amount of RAM (RAM consumption depends on how many images and
how larger are them). So, if you don't have enough RAM, please, reduce 'Slide' size on the 'Options' dialog.
</p>
<h1>Quick start guide</h1>
<p>YACReader is the reading app in the YACReader suite. Use it to open a comic file directly, open a folder of images, or continue reading something launched from YACReaderLibrary.</p>
<p>This guide focuses on the current essentials. For the full list of keyboard shortcuts, and to customize them, open the <b>Shortcuts</b> dialog from the toolbar, menu, or settings dialog.</p>
<h2>Start reading</h2>
<ul>
<li>Open a comic file, open a folder, or drag and drop content into the window.</li>
<li>YACReader supports the usual comic archive workflow and image folders. Some builds also support PDF reading.</li>
<li>If you open a folder, YACReader can move through the neighboring files in that folder so it works well for sequential reading.</li>
<li>The app remembers your recent files and your last reading position for each comic.</li>
</ul>
<h2>Choose a reading mode</h2>
<ul>
<li>Use the toolbar to switch between fit width, fit height, fit page, full size, and continuous scroll mode.</li>
<li>Enable double page mode when it fits the comic better, or switch to manga double page mode to reverse the reading order.</li>
<li>The page flow lets you browse visually before jumping to a page.</li>
<li>The magnifying glass is available while reading and can be resized and zoomed independently.</li>
</ul>
<h2>Move around the comic</h2>
<ul>
<li>You can read with the keyboard, mouse wheel, trackpad, or the mouse mode selected in the options dialog.</li>
<li>Use the Go To dialog for an exact page jump, or open the page flow for quick visual navigation.</li>
<li>Bookmarks are useful for favorite pages, and YACReader also keeps track of the latest page you were reading.</li>
<li>The information overlay can show page progress while you read, and the translator tool can be toggled from the toolbar or menu.</li>
</ul>
<h2>Shortcuts</h2>
<ul>
<li>Open the <b>Shortcuts</b> dialog to discover every available shortcut and change it to your liking.</li>
<li>The dialog groups actions by area, so it is the best place to learn what is available in the viewer.</li>
<li>This help page avoids a fixed shortcut table because shortcuts are customizable and may not match your setup anymore.</li>
</ul>
<h2>Useful settings</h2>
<ul>
<li>The options dialog includes language selection, appearance and theme settings, background color, page flow behavior, and image adjustment controls.</li>
<li>You can tune brightness, contrast, gamma, scaling quality, and whether small images should be enlarged to fit the page.</li>
<li>If you use a trackpad or prefer a specific click behavior, review the scroll and mouse mode settings first.</li>
<li>Light and dark themes can follow the system setting, and custom themes can be loaded too.</li>
</ul>
<p>If you mainly want to manage a collection, search across it, or edit comic metadata, use YACReaderLibrary and open the selected comic from there.</p>
<p>More information about the project is available at <a href="https://www.yacreader.com">https://www.yacreader.com</a>.</p>
</body>
</html>
</html>