diff --git a/ZIP.md b/ZIP.md new file mode 100644 index 0000000..747deec --- /dev/null +++ b/ZIP.md @@ -0,0 +1,17 @@ +# ZIP file support + +Koreader can read files stored/compressed in ZIP files. For example, a TXT file can be compressed and stored in a ZIP file to save space. There is an expected naming convention where the filename ends in .FORMAT.ZIP, for example for a compressed text (TXT) file the file should end in .txt.zip + +Koreader does not create zip files nor does it offer ZIP browsing support. + +## Naming Convention + + * fb2.zip - FictionBook + * htm.zip - html + * html.zip - html + * log.zip - text log files + * md.zip - Markdown + * rtf.zip - Rich Text Format + * txt.zip - plain text + +If the documents are not named like this, the wrong reader/format engine is likely to be used and "No reader engine for this file of invalid file" will be displayed. Either rename the file to match conventions so that opening normally "just-works" or long-pressing the filename and then choose "Open with.." and select the correct engine. For more information see https://github.com/koreader/koreader/issues/9986