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

28 Commits

Author SHA1 Message Date
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
Qingping Hou
6493b643ec doc: Event page 2016-03-12 01:10:35 -08:00
Qingping Hou
93b9e245a9 doc: update hacking 2016-02-29 23:13:52 -08:00
Qingping Hou
815c5924e3 add documentation for wbuilder 2016-02-17 21:07:33 -08:00
Qingping Hou
e410ce14df doc: types/functions for font and rendertext module 2016-02-15 16:14:15 -08:00
Qingping Hou
e2096ed8d9 doc: add documentation build infrastructure 2016-02-04 10:24:53 -08:00