Archives
/
koreader
mirror of https://github.com/koreader/koreader
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: update readme

Browse Source
pull/1804/head
Qingping Hou 8 years ago
parent ad3b2dad1a
commit 8203ba2ec6
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File

21
README.md
Unescape Escape View File

@ -43,7 +43,7 @@ Highlights for developers
* running on multi-platform with only one code-base maintained * running on multi-platform with only one code-base maintained
* developing koreader in any editor without compilation * developing koreader in any editor without compilation
* high runtime efficiency by LuaJIT acceleration * high runtime efficiency by LuaJIT acceleration
* light-weight widget toolkit for small memory footprint * light-weight self-contained widget toolkit with small memory footprint
* extensible with plugin system * extensible with plugin system
* interfaced backends for documents parsing and rendering * interfaced backends for documents parsing and rendering
* high quality document backend libraries like MuPDF, DjvuLibre and CREngine * high quality document backend libraries like MuPDF, DjvuLibre and CREngine
@ -51,7 +51,7 @@ Highlights for developers
* in active development * in active development
* contributed by developers around the world * contributed by developers around the world
* continuous integration with Travis CI * continuous integration with Travis CI
* with unit tests and code coverage test * with unit tests, static analysis and code coverage test
* automatic release of nightly builds * automatic release of nightly builds
* free as in free speech * free as in free speech
* licensed under Affero GPL v3 * licensed under Affero GPL v3
@ -147,8 +147,8 @@ package from scratch.
For Android devices For Android devices
------------------- -------------------
Make sure the "android" and "ndk-build" tools are in your PATH variable Make sure the "android" and "ndk-build" tools are in your PATH environment
and the NDK variable points to the root directory of the Android NDK. variable and the NDK variable points to the root directory of the Android NDK.
Then, run this command to build installable package for Android: Then, run this command to build installable package for Android:
``` ```
@ -163,22 +163,23 @@ To build an emulator on current Linux machine just run:
./kodev build ./kodev build
``` ```
If you want to compile the emulator for Windows you need to run: If you want to compile the emulator for Windows run:
``` ```
./kodev build win32 ./kodev build win32
``` ```
To run Koreader on your developing machine To run Koreader on your developing machine:
``` ```
./kodev run ./test ./kodev run
``` ```
To run unit tests: To run unit tests:
``` ```
make test ./kodev test base
./kodev test front
``` ```
To run Lua static-analysis for KOReader: To run Lua static analysis:
``` ```
make static-check make static-check
``` ```
@ -203,7 +204,7 @@ modifications with kroeader frontend. NOTE: only support relative path for now.
Translation Translation
======== ===========
Please refer to [l10n's README][l10n-readme] to grab the latest translations Please refer to [l10n's README][l10n-readme] to grab the latest translations
from [the Koreader project on Transifex][koreader-transifex] with this command: from [the Koreader project on Transifex][koreader-transifex] with this command:

Write Preview
Loading…
Cancel
Save