Skip to content

Commit d74fc0d

Browse files
author
Vadim Lopatin
committed
update readme
1 parent c294459 commit d74fc0d

1 file changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,29 @@ CoolReader 3 - cross platform open source e-book reader
33

44
(c) Vadim Lopatin, 1998-2018
55

6+
7+
[![Join the chat at https://gitter.im/coolreader/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/coolreader/Lobby)
8+
9+
10+
611
LICENSE: All source codes (except thirdparty directory)
712
are provided under the terms of GNU GPL license, version 2
813

9-
[![Join the chat at https://gitter.im/coolreader/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/coolreader/Lobby)
1014

1115

1216
Development is moved to GitHub
1317

1418
https://github.com/buggins/coolreader
1519

1620

17-
Source codes are available at sourceforge:
21+
Sourceforge repository will be used as a mirror
1822

1923
git clone git://crengine.git.sourceforge.net/gitroot/crengine/crengine
2024

2125

2226

23-
Directories:
27+
Directories
28+
-----------
2429

2530
crengine - CREngine (DOM/XML/CSS ebook rendering library) sources
2631
cr3gui - CR3 with CR3GUI for e-ink devices sources
@@ -31,7 +36,8 @@ Directories:
3136
tools - miscellaneous configuration files
3237
android - Android port
3338

34-
External dependencies:
39+
External dependencies
40+
---------------------
3541

3642
common: zlib, libpng, libjpeg, freetype, harfbuzz
3743
cr3gui/xcb: libxcb, fontconfig
@@ -40,9 +46,11 @@ External dependencies:
4046
cr3/wx: wxWidgets 2.8
4147

4248
e.g., for Ubuntu you may use
49+
4350
> sudo apt-get install git-core cmake libqt4-dev libpng12-dev libfreetype6-dev libjpeg62-dev libfontconfig1-dev zlib1g-dev
4451

45-
Packaging:
52+
Packaging
53+
---------
4654

4755
Debian based packages included to project:
4856

@@ -54,8 +62,18 @@ To build debian package, copy one of package descriptions from packages director
5462
cp -r packages/ubuntu/debian debian
5563
Then, package can be built using `debuild` command.
5664

57-
Build instructions
58-
------------------
65+
66+
Android Build Instructions
67+
--------------------------
68+
69+
Use Android Studio - open android/app as Android Studio project
70+
71+
Ensure that you have Android SDK and NDK installed
72+
73+
74+
75+
CMake Build Instructions
76+
------------------------
5977

6078
# Building QT version
6179
# libqt4-dev should be installed
@@ -191,6 +209,7 @@ QT Build under Windows
191209
Using QT SDK
192210

193211
Environment setup:
212+
194213
- Download and install QT SDK, git, cmake, msys
195214
- Copy contents of git and cmake dirs to QT/mingw/
196215
- Copy make.exe from msys/bin to QT/mingw/bin
@@ -217,12 +236,17 @@ For QT5, use GUI=QT5 instead of GUI=QT
217236
For building Qt5 app from QtCreator remove -G (generator) parameter:
218237

219238
Release build:
239+
220240
-D GUI=QT5 -D CMAKE_BUILD_TYPE=Release -D CMAKE_INSTALL_PREFIX=dist ..
241+
221242
Debug build:
243+
222244
-D GUI=QT5 -D CMAKE_BUILD_TYPE=Debug -D CMAKE_INSTALL_PREFIX=dist ..
223245

224246
It will put built cr3.exe and all necessary distribution files to directory qtbuild/dist.
247+
225248
You need also add following DLLs to this directory in order to get cr3.exe working:
249+
226250
- mingwm10.dll
227251
- QtCore4.dll
228252
- QtGui4.dll

0 commit comments

Comments
 (0)