smallsolar
/
kiwix-build
mirror of https://github.com/kiwix/kiwix-build.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #565 from kiwix/container-doc

This commit is contained in:
Matthieu Gautier 2023-02-08 17:22:25 +01:00 committed by GitHub
parent dc0d0804e4 d89f622471
commit d8c9d5c45d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -164,6 +164,24 @@ Kiwix-build.py will create several directories:
If you want to install all those directories elsewhere, you can pass the If you want to install all those directories elsewhere, you can pass the
`--working-dir` option to `kiwix-build`: `--working-dir` option to `kiwix-build`:
CI/CD containerised environments
--------------------------------
Beside the `kiwix-build` command line tool, Kiwix Build proposes
[prepared compilation environments for multiple GNU/Linux
systems](.github/ci_images/) too.
These prepared environments include: compilers, binary toolchains and
any third-party tool necessary to run the compilation toolchain. They
don't contain pre-compiled library dependences build by kiwix-build, (like Xapian, Libicu,
Libmicrohttps, ...) but it contains dependencies installed with package manager.
These container images are necessary and intended to be used by Kiwix
itself in many of its CI. But they are free to download et can be
reused, although they can break anytime, therefore at your won risk.
You can find them on [Docker
Hub](https://hub.docker.com/r/kiwix/kiwix-build_ci).
Troubleshooting Troubleshooting
--------------- ---------------