Commit Graph

27 Commits

Author SHA1 Message Date
Kelson 8eb2d0c2a1 Explain how to run automated tests 2020-05-18 08:37:51 +02:00
renaud gaudin ea3444e2fe add required info to README
Mustache 4 was release in late october 2019 and is not compatible with kiwix-lib as is.
Replacement in taskbar is messed-up and breaks suggestions.
Until this is fixed/adapted, inform users to use version 3.
2020-04-03 16:38:16 +02:00
Kelson 778603e1bf
Use Github Actions CI badge (instead of Travis CI) 2020-04-03 16:30:42 +02:00
Kelson 2244074f3c
travis-ci.org -> travis-ci.com 2019-12-05 08:10:56 +01:00
Kelson f85ec9ea6f Add Codecov badge to README 2019-09-26 12:37:57 +02:00
Kelson f4e9148b1d
Small fix of OSes names in the README 2019-09-17 12:20:17 +02:00
Kelson e1fcd12e48 Add AUR badge 2019-09-08 17:05:44 +02:00
Kelson bbb346b685 Slight improvements of the README.md 2019-08-27 16:31:04 +02:00
Emmanuel Engelhart efce01aec4 Add badges to the README 2019-07-31 18:08:09 +02:00
Kelson f33f4eb381 Replace HTTP links by HTTPs one 2019-07-23 15:19:01 +02:00
Matthieu Gautier 72b4af4d65 Add information about mustache dependency in the README. 2019-03-04 14:26:40 +01:00
Matthieu Gautier 92c9a47a0d Move the templating system to mustache instead of ctpp2.
Mustache templating system is a bit simpler than ctpp2 and ctpp2 is no
more maintained (see #189).
We are moving to the kainjow's Mustache project
(https://github.com/kainjow/Mustache).

It simplify a lot our system has it is header only and we don't have to
precompile the template.

Fix #21
2019-01-09 18:28:48 +01:00
Matthieu Gautier 5159d985c6 Remove support for external index.
This feature is considered obsolete for a while.
In fact, it was already not supported since June 2018 as we were compiling
xapian without the chert backend support.

Assume that we don't support it and remove it from the code.
See kiwix/kiwix-tools#245

This is a API break. library.xml files will still work but the indexPath
and indexType will be dropped silently from the file.
2019-01-07 16:47:08 +01:00
Kelson c0d5e091d3 Small update of the README 2018-07-07 21:15:48 +02:00
Emmanuel Engelhart a66b178633 Update README 2018-06-24 22:16:16 +02:00
Matthieu Gautier 6b0d2788aa Add dependency `libaria2` in the README. 2018-04-23 17:40:21 +02:00
RohanBh 683b5249a2 Fix meson installation error by using pip3 2018-03-10 03:10:09 +05:30
Emmanuel Engelhart 8e8724b6be Fix typo in the README 2017-02-06 20:52:47 +01:00
Emmanuel Engelhart 094e05ac8a ctpp2 static lib as a non std name 2017-02-03 07:15:21 +01:00
Emmanuel Engelhart c15339a972 Small remark to install deps locally 2017-01-23 22:04:50 +01:00
Emmanuel Engelhart ffb1f40671 Do not forget pkg-config 2017-01-23 21:33:55 +01:00
Emmanuel Engelhart 121693bcfa Typo on the README 2017-01-23 21:31:44 +01:00
Emmanuel Engelhart d2c3eeb337 More simple/robus README 2017-01-23 21:25:07 +01:00
Matthieu Gautier ed800e4f00 Update README.
Also add a COMPILE_ubuntu-16.04.md to let people compile on ubuntu 16.04.
2017-01-23 15:24:24 +01:00
Matthieu Gautier d9798414c3 Update README.md
- Mention kiwix-build to build kiwix-lib.
- Separate the real dependencies from the package to install.
- Mention the (standard meson) --default-library option.
2017-01-10 10:50:04 +01:00
Kunal Mehta 3bfcd89e22 Document libctpp2-dev dependency (fixes #11) 2017-01-09 23:12:30 -08:00
Kunal Mehta 12b6a50dba Add README with build instructions (closes #3, #6) 2017-01-02 06:57:01 -08:00