Paelito

Installation

For Windows OS

  1. Download from Here
  2. And then Run the downloaded setup

For Ubuntu OS

  1. Install with sudo snap install paelito

Updating the Books that Comes with Paelito

Delete the book and it would be redownloaded.

Creating a Paelito Book

On Windows the book's folder must be created in $HOME\paelito_data\p

On Ubuntu the book's folder must be created in $HOME/snap/paelito/common/p

Every item of the book must be placed in the a single directory. There must not be any subdirectory.

Each book must be written using markdown. A search on Google would explain how to use it.

Every book must contain the following: details.json, toc.txt, cover.png, some markdown files

a bg.png (repeating sprite) is optional.

details.json

A sample details.json

{
  "FullTitle": "The Botanum",
  "Comment": "A collection of short stories.",
  "Author1": "Bankole Ojo",
  "UpdateURL": "https://saenuma.com/latest_botanum_version",
  "BookSourceURL": "https://saenuma.com/page/paelito",
  "Contact": "ojobankole@gmail.com"
}
  

If the authors are about three, you need to include the following fields to your details.json: Author1, Author2, Author3

The contact should be an email.

toc.txt

A sample toc.txt

A Business Man
a_business_man.md

A Factory Boss
a_factory_boss.md

A Poor Person
a_poor_person.md

Bad Marriages
bad_marriages.md

Birghead
birghead.md

Birth of Gavinska
gavinska.md

Broken Company
broken_company.md

Dead Men Arose
dead_men.md

Dead Sames
dead_sames.md

Fiction on Ardarn
ardarn.md

  

On Images

To include an image into your book, please include the image into the book folder

To display the image, say for example dd.png write it such as:

![dd](dd.png)
.

Final Step

On ubuntu run paelito.maker {folder_name} to create the book

On windows switch ot C:\Program Files (x86)\Paelito and the run paelito_maker.exe {folder_name} to create the book

Reading a book

On Windows the book must be placed in $HOME\paelito_data\lib

On Ubuntu the book must be placed in $HOME/snap/paelito/common/lib