Giter VIP home page Giter VIP logo

kiwix-desktop's Introduction

Download on Flathub

Kiwix Desktop

The Kiwix Desktop is a viewer/manager of ZIM files for GNU/Linux and Microsoft Windows OSes.

Release Repositories Build Status CodeFactor License: GPL v3

Disclaimer

This document assumes you have a little knowledge about software compilation. If you experience difficulties with the dependencies or with the Kiwix library compilation itself, we recommend to have a look at kiwix-build.

Dependencies

The Kiwix Desktop application relies on many third party software libraries. The following libraries need to be available:

These dependencies may or may not be packaged by your operating system. They may also be packaged but only in an older version. The compilation script will tell you if one of them is missing or too old. In the worst case, you will have to download and compile a bleeding edge version by hand.

Libkiwix has to be compiled dynamically, the best way to have it is to use kiwix-build.

Install needed packages (on Ubuntu 18.04+):

sudo apt-get install libqt5gui5 qtbase5-dev qtwebengine5-dev \
     libqt5svg5-dev qt5-image-formats-plugins aria2 \
     qttools5-dev-tools qtchooser qt5-qmake \
     qtbase5-dev-tools

Compilation

Once all dependencies are installed, you can compile Kiwix Desktop:

qmake .
make

qmake will use pkg-config to locate libraries. Depending on where you've installed libkiwix (and other libraries) you may have to update the env variable PKG_CONFIG_PATH. It can be set as follows, for example, for x86-64 native systems:

export PKG_CONFIG_PATH="<...>/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu/pkgconfig"

You may want to simply open the kiwix-desktop project in QtCreator and then compile the project from there (don't forget to update PKG_CONFIG_PATH if necessary).

Installation

To install Kiwix Desktop on the system:

sudo make install

Run

To run Kiwix Desktop

kiwix-desktop

You might have to refresh the ld database before:

sudo ldconfig

If you face problems such as library not found..., add the following environment variable:

LD_LIBRARY_PATH="<...>/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu"

Communication

Available communication channels:

For more information, please refer to https://wiki.kiwix.org/wiki/Communication.

License

GPLv3 or later, see LICENSE for more details.

kiwix-desktop's People

Contributors

mgautierfr avatar kelson42 avatar jetownfeve21 avatar juuz0 avatar translatewiki avatar asashnov avatar legoktm avatar hanyoung-uwu avatar veloman-yunkan avatar xvitaly avatar rishabh-soni avatar quentin-hsk avatar maneeshpm avatar mananjethwani avatar amire80 avatar abijeet avatar psypherium avatar goutte avatar hashworks avatar ambrevar avatar popolechien avatar ksc3899 avatar saket-07 avatar vishal-1408 avatar rgaudin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.