2
0
mirror of https://github.com/koreader/koreader synced 2024-11-10 01:10:34 +00:00
Commit Graph

55 Commits

Author SHA1 Message Date
Benoit Pierre
2403087f68
doc: update Android build instructions (#12368) 2024-08-17 22:50:21 +02:00
Frans de Jonge
6eddc66516
[doc] Build: update Android instructions to openjdk-17-jdk-headless (#12345)
Closes #12344.
2024-08-13 17:27:34 +02:00
Benoit Pierre
f22e8bbbc2
doc: update building documentation (#12295)
Meson is now required.
2024-08-05 13:00:38 +02:00
Benoit Pierre
18439e7578
doc: explicitly mention perl dependency (#12240)
It usually gets pulled when installing git.
2024-07-30 08:36:08 +02:00
Benoit Pierre
ce8e27a67c doc: update macOS building instructions 2024-07-19 22:43:42 +02:00
Nikola Kotur
48c41fccee
doc: add Arch Linux building instructions (#12090) 2024-06-26 12:03:25 +02:00
Benoit Pierre
6e81162231
doc: update building documentation (#11961)
Together with koreader/koreader-base#1810, close #10116.

Supersede #10115.
2024-06-14 14:00:48 +02:00
Benoit Pierre
a9a023c062
doc: fix android NDK / SDK instructions (#11818) 2024-05-14 12:17:59 +02:00
Benoit Pierre
12552f1c71
doc: remove ragel from the build requirements (#11661)
Not necessary anymore.
2024-04-10 23:30:52 +02:00
Frans de Jonge
6e57ccaf4f
[doc] Building targets: remove mentions of Ubuntu Touch (#10974)
Deprecated or at least untested for years. Noticed due to <https://github.com/koreader/koreader/discussions/10972#discussion-5701647>
2023-10-12 14:46:58 +02:00
Frans de Jonge
1f03e76aea
[doc] Building: add libtool-bin to Debian/Ubuntu prerequisites as a workaround for ancient libzmq (#10897)
Fixes #10896.

It's because of an extremely old version of libzmq, fixed since <https://github.com/zeromq/libzmq/pull/1497>.
2023-09-14 10:51:34 +02:00
NiLuJe
53e6cf563a
Deal with table.pack corner-cases properly (#10350)
c.f., https://github.com/koreader/koreader-base/pull/1603 for more
details.

Re: #9624
2023-04-24 00:21:05 +02:00
NiLuJe
da65ac8b02
Cleanup various varargs shenanigans (#9624)
* Iterate over varargs directly via select if possible
* Use table.pack otherwise (https://github.com/koreader/koreader-base/pull/1535).
* This allows us to simplify a few Logger calls, as logger now handles nil values.
2022-10-12 19:59:48 +02:00
Frans de Jonge
57b9c08f5a
[doc] Update busted version mentioned in docs (#9078) 2022-05-07 18:22:55 +02:00
Frans de Jonge
4b0f7471f4
Fix docs after Exporter plugin refactor (#9075)
The file was moved in <https://github.com/koreader/koreader/pull/8944> but not changed in the docs config.
2022-05-07 08:59:12 +02:00
raffaem
f37699a12b
[doc] Build deps for Fedora (#9034)
The build deps listed in the README are not sufficient to build
KOReader. Inserting the full list of dependencies.
2022-04-24 10:30:28 +02:00
Will
f709cc48e6
[doc] Add location of logs to Hacking document (#8901) 2022-03-14 09:07:08 +01:00
Frans de Jonge
9a2cf203b1
Fix docs, evernote → exporter (#8158)
Cf. https://github.com/koreader/koreader/pull/7983#issuecomment-908981240
2021-08-31 09:51:12 +02:00
NiLuJe
2d12f8a8ee Mention that arguments are always evaluated, to curb enthusiasm at
putting too much fancy stuff in a logger call ;).

(Not actually an issue in our current codebase).
2021-08-09 02:32:58 +02:00
yparitcher
dc59391632
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999)
This fixes inheritance issues when changing documents.
Also allow "Go to page" in FM.
2021-07-23 13:27:12 +02:00
Frans de Jonge
81eb5f8c49
Add Lua 5.1 to sample Debubuntu apt-get command (#7421)
To ensure it gets installed.

Cf. <https://github.com/koreader/koreader/issues/7409#issuecomment-800267291>.
2021-03-27 10:41:01 +01:00
NiLuJe
fe10d0bce5
Revamp flash_ui handling, once more, with feeling ;) (#7262)
* Simplify flash_ui handling (by handling the unhighlight pre-callback, c.f., #7262 for more details).
* UIManager: Handle translucent window-level widgets (and those wrapped in a translucent MovableContainer) properly in setDirty directly, making sure what's *underneath* them gets repainted to avoid alpha layering glitches. (This was previously handled via localized hacks).
* Update UIManager's documentation, and format it properly for ldoc parsing, making the HTML docs more useful.
* ReaderView: Reinitialize the various page areas when opening a new document, to prevent poisoning from the previous document.
* Event: Handle nils in an event's arguments.
* CheckButton/RadioButton: Switch to simple inversion to handle highlighting
* CheckButton: Make the highlight span the inner frame's width, instead of just the text's width, if possible.
* AlphaContainer: Fix & simplify, given the UIManager alpha handling.
* MovableContainer: When translucent, cache the canvas bb used for composition.
* Avoid spurious refreshes in a few widgets using various dummy *TextWidgets in order to first compute a text height.
* KeyValuePage: Avoid floats in size computations.
2021-02-20 18:22:48 +01:00
NiLuJe
995668ac02
Unbreak macOS build (#7313)
* Bump base

https://github.com/koreader/koreader-base/pull/1308
https://github.com/koreader/koreader-base/pull/1310

* Include bison in macOS build deps

Apparently something in gettext is possibly unhappy with the hilariously
outdated stock version (2.3).
2021-02-18 23:46:29 +01:00
Rex Kerr
286a6b4883
Emulator: update mac instructions to include gnu grep (#7266)
Since `grep -z` is not available on posix grep
2021-02-10 20:55:26 +01:00
NiLuJe
04a980649f
kodev: Use getopt instead of a hand-rolled hack (#6980)
* Update log android to match the current issue template
* Fix GUI gdb frontends getting wrecked by the older glib library we ship w/
KOReader
* Slightly more aggressive valgrind defaults
  It's slower, but interpreting results without leak-check=full ends up
  costing more time than just running with it.
* Add a callgrind shortcut
* Use getopt instead of a hand-rolled hack for option parsing
* Make it clearer that complex args should be quoted
* Document prompt
* Add a Valgrind suppression file for libdrm/mesa on AMD hardware
  Because mesa/libdrm isn't built w/ -D valgrind=enabled on Gentoo,
  and Valgrind is very much not happy with mesa ;p.
* Allow toggling reader.lua's sane return mode
  (Enabled automatically under gdb/valgrind).
  Should hopefully weed out some noise from valgrind reports.
* Propagate reader.lua's return code
* Sim a few other common devices
* Handle assigning values to short options with an equal instead of a space, like the previous solution
  (This is purely for backward compatibility purposes, this is a syntax that'd fail with the C getopt, too).
* Add gnu-getopt to the build requirement on macOS, because of course everything is terrible.
2020-12-18 18:26:32 +01:00
Frans de Jonge
090f33b5b8
[fix] Minor doc touchups re. QR encode (#6861)
Cf. <https://github.com/koreader/koreader/pull/6844#issuecomment-723672448>.
2020-11-09 09:17:11 +01:00
yparitcher
602e0b3feb ldoc fixes 2020-10-20 18:11:55 -04:00
NiLuJe
f0f0cfd167
[Dev docs] Steer people more strongly towards koxtoolchain (#6727)
* Steer people more strongly towards koxtoolchain

And stop mentioning blatantly broken/outdated stuff

* Add macOS to the list

Also, put 'em in hierarchical order, and link to the main build docs for
the native emulator.
2020-09-29 15:06:40 +02:00
yparitcher
70f89c4df1
ReaderGesture: cleanup (#6292)
convert all gesture actions to use events for better modularity
add network event handlers and device event handlers
2020-07-12 14:47:49 -04:00
Martín Fernández
f4dad2fae8
[doc] WSL extra bits (#6368)
Fixes #6354
2020-07-11 08:16:26 +02:00
Frans de Jonge
f8af0a9e0e
[doc] Add some tips about GitHub PR refs (#6289) 2020-06-24 12:49:34 +02:00
Frans de Jonge
48060c3b86
[fix] Ignore sha2.lua in doc generation (#6229)
Otherwise it'll choke on the comments in that file.

See <https://github.com/koreader/koreader/pull/6195#issuecomment-638801075>.

Accidentally introduced in <https://github.com/koreader/koreader-base/pull/1105>.
2020-06-04 15:34:16 +02:00
NiLuJe
c54578e254
[doc] macOS build info tweaks (#5891)
* Update macOS PATH shenanigans.

c.f., https://github.com/koreader/koreader-base/pull/1052

* Prefer coreutils, it now ships everything we need.

(Or it always did? I apparently don't actually have coreutils
installed on my end).

* Also recommend putting Homebrew first in PATH

Mainly because it turns out that's how I tested this the last time ;).
Also, it  just makes sense, and might be part of Homebrew's
recommendations anyway.
2020-02-22 09:11:29 +01:00
Thomas Spurden
f3d2ef18f7
[doc] Add some basic info on using ffi-cdecl (#5808) 2020-02-12 17:40:38 +01:00
Frans de Jonge
9674928cbe
[doc] Add ragel to build prerequisites (#5743)
See discussion in https://github.com/koreader/koreader-base/pull/1025#issuecomment-570556188
2020-01-06 20:37:58 +01:00
yparitcher
0f896765c3 transifex -> weblate fixes (#5722) 2020-01-01 21:18:09 +01:00
Frans de Jonge
16fd731f73
[doc] Add coreutils to Mac brew dependencies (#5608)
See 75d02a9038 (commitcomment-36008019)
2019-11-18 17:55:40 +01:00
NiLuJe
4f52c4147f
Fix a deadlock with empty settings (#5546)
* Fix deadlock on empty settings
Emulator only. Was stuck looping forever on directory == base == .
2019-10-30 00:27:54 +01:00
NiLuJe
eae105bb72
Minor dev documentatioon tweaks (#5518)
* Made Porting not so hilariously outdated.
* Minor tweaks to the macOS build instructions and the various quirks involved in getting it to behave (and accompanying actual build fixes).
2019-10-22 01:25:00 +02:00
Frans de Jonge
a47b3b1a5b
[doc] Add internal documentation references (#5285)
Also some minor grammatical fixes.
2019-08-30 15:06:30 +02:00
Frans de Jonge
a2dcfe9aec
[doc] Tag @todo, @fixme and @warning (#5244)
This commit standardizes the various todos around the code a bit in a manner recognized by LDoc.

Besides drawing more attention by being displayed in the developer docs, they're also extractable with LDoc on the command line:

```sh
ldoc --tags todo,fixme *.lua
```

However, whether that particular usage offers any advantage over other search tools is questionable at best.

* and some random beautification
2019-08-23 19:53:53 +02:00
Frans de Jonge
8be113e4bd
[fix] Update LDoc config (#5231)
Follow-up to #5217.
2019-08-20 17:41:09 +02:00
Martín Fernández
57d9f75f53 [doc] Simplify and reorganize readme (#5217)
References #5213.
2019-08-20 17:01:28 +02:00
Frans de Jonge
032d1afc8e
doc/Unit tests: minor extra explanation (#3462) 2017-11-03 15:24:55 +00:00
Frans de Jonge
e566a7ffc6 kodev: add hidpi shortcut and dpi argument (#3208)
* [doc] also generate base ffi doc
* kodev: add hidpi shortcut and dpi argument
* Bump base
2017-09-14 13:19:20 +02:00
Frans de Jonge
c847d628e1 Docs: cosmetic updates and additions
* Content from wiki had some cosmetic leftover glitches
* Added/adapted some docs for other modules
2017-04-12 11:27:22 -07:00
Frans de Jonge
e217b99fa6 Dev docs (#2730) 2017-04-08 03:44:59 -07:00
Qingping Hou
09564d4b4d doc: event propagation for widgets 2016-12-11 12:20:59 -08:00
Dimitrios Semitsoglou-Tsiapos
2ed6cf760d Finish renaming utils to tools
Continues the work of 9afad43a3e
2016-11-25 14:43:08 -08:00
Qingping Hou
42d74c0a36 doc: add sqlite sample code 2016-11-19 12:15:27 -08:00