Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Commit

Permalink
Add docs folder
Browse files Browse the repository at this point in the history
  • Loading branch information
mstuttgart committed Apr 16, 2019
1 parent b079734 commit 6d09015
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Pynocchio Comic Reader

Pynocchio is a image viewer specialized in comic reading.

<p align="center">
<img src="https://github.com/pynocchio/pynocchio/raw/develop/data/screenshots/screenshot_02.png" alt="Pynocchio Comic Reader - Main Screen">
</p>


* This screenshots contains a page of the webcomic [Pepper&Carrot](https://www.peppercarrot.com/) by David Revoy licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).

## Features

The current version is stable and we intend to improve it even more.

* Support several view adjust modes using anti-aliasing.
* Support the several image formats provide by Qt5: WEBP, JPG, JPEG, PNG, GIF, BMP, PBM, PGM, PPM, XBM, XPM.
* Support a several comic formats like .ZIP, .RAR, .TAR, .CBT, .CBR, .CBZ.
* Double page and manga read mode
* Elegant visual, free and easy to use! :)

## Install

### Ubuntu

Install in Ubuntu 16.04 Xenial.

Please, visit the latest release [here](https://github.com/mstuttgart/pynocchio/releases/latest) or in [Linux Apps](https://www.linux-apps.com/p/1126786) and download *Pynocchio_x.y.z_amd64.deb* file.

### Other Linux distributions

Download *tar.gz* file and use the instructions in [contruibute page](CONTRIBUTING.md).

## Contributing

If you'd like to contribute, please see [contributing page](CONTRIBUTING.md).

## Third party resources

Pynocchio use [Elementary USU Icon Theme](https://store.kde.org/content/show.php/elementary+USU?content=148128) icon set free pack.

## Credits

Copyright (C) 2014-2019 by Michell Stuttgart
Empty file added docs/_config.yml
Empty file.

0 comments on commit 6d09015

Please sign in to comment.