From cd084c406719556f7f223109fde14302d1483126 Mon Sep 17 00:00:00 2001 From: Joseph Cloutier Date: Mon, 9 May 2022 16:45:33 -0400 Subject: [PATCH] Improve documentation. --- project/lib/README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/project/lib/README.md b/project/lib/README.md index 50be71340..92d335a4e 100644 --- a/project/lib/README.md +++ b/project/lib/README.md @@ -1,56 +1,58 @@ Submodule projects ================== +Lime's native target uses code from several C/C++ projects, each of which is treated as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). + Where possible, Lime prefers to use GitHub repositories as submodules, as this makes browsing easier. (GitHub refuses to link to non-GitHub repos.) However, several of these repositories are mirrored from elsewhere, and will ignore issues and pull requests submitted on GitHub. **Always submit issues and pull requests to the primary repo, not to a GitHub mirror.** -Cairo: [homepage](https://www.cairographics.org/) | [repo](https://gitlab.freedesktop.org/cairo/cairo) | [GitHub mirror](https://github.com/freedesktop/cairo) +Cairo: [homepage](https://www.cairographics.org/) | [primary repo](https://gitlab.freedesktop.org/cairo/cairo) | [GitHub mirror](https://github.com/freedesktop/cairo) -cURL: [homepage](https://curl.se/) | [repo](https://github.com/curl/curl) +cURL: [homepage](https://curl.se/) | [primary repo](https://github.com/curl/curl) -efsw: [repo](https://github.com/SpartanJ/efsw) +efsw: [primary repo](https://github.com/SpartanJ/efsw) -FreeType: [homepage](https://freetype.org/) | [repo](https://gitlab.freedesktop.org/freetype/freetype) | [GitHub mirror](https://github.com/freetype/freetype) +FreeType: [homepage](https://freetype.org/) | [primary repo](https://gitlab.freedesktop.org/freetype/freetype) | [GitHub mirror](https://github.com/freetype/freetype) -HarfBuzz: [homepage](https://harfbuzz.github.io/) | [repo](https://github.com/harfbuzz/harfbuzz) +HarfBuzz: [homepage](https://harfbuzz.github.io/) | [primary repo](https://github.com/harfbuzz/harfbuzz) libjpeg: [homepage](https://ijg.org/) | [download](https://ijg.org/files/) | [unofficial GitHub mirror](https://github.com/openfl/libjpeg) LZMA: [homepage + download](https://www.7-zip.org/sdk.html) | [unofficial GitHub mirror](https://github.com/openfl/liblzma) -mbed TLS: [homepage](https://tls.mbed.org/) | [repo](https://github.com/Mbed-TLS/mbedtls) +mbed TLS: [homepage](https://tls.mbed.org/) | [primary repo](https://github.com/Mbed-TLS/mbedtls) -MojoAL: [homepage](https://icculus.org/mojoAL/) | [repo](https://github.com/icculus/mojoAL/) +MojoAL: [homepage](https://icculus.org/mojoAL/) | [primary repo](https://github.com/icculus/mojoAL/) -Neko: [homepage](https://nekovm.org/) | [repo](https://github.com/HaxeFoundation/neko) +Neko: [homepage](https://nekovm.org/) | [primary repo](https://github.com/HaxeFoundation/neko) -Ogg: [homepage](https://www.xiph.org/ogg/) | [repo](https://github.com/xiph/ogg) +Ogg: [homepage](https://www.xiph.org/ogg/) | [primary repo](https://github.com/xiph/ogg) -OpenAL soft: [homepage](https://openal-soft.org/) | [repo](https://github.com/kcat/openal-soft) +OpenAL soft: [homepage](https://openal-soft.org/) | [primary repo](https://github.com/kcat/openal-soft) -Pixman: [homepage](http://pixman.org/) | [repo](https://gitlab.freedesktop.org/pixman/pixman) | [GitHub mirror](https://github.com/freedesktop/pixman) +Pixman: [homepage](http://pixman.org/) | [primary repo](https://gitlab.freedesktop.org/pixman/pixman) | [GitHub mirror](https://github.com/freedesktop/pixman) -libpng: [homepage](http://www.libpng.org/pub/png/libpng.html) | [repo](https://sourceforge.net/p/libpng/code) +libpng: [homepage](http://www.libpng.org/pub/png/libpng.html) | [primary repo](https://sourceforge.net/p/libpng/code) -SDL: [homepage](https://www.libsdl.org/) | [repo](https://github.com/libsdl-org/SDL) +SDL: [homepage](https://www.libsdl.org/) | [primary repo](https://github.com/libsdl-org/SDL) -tiny file dialogs: [homepage](https://sourceforge.net/projects/tinyfiledialogs/) | [repo](https://sourceforge.net/p/tinyfiledialogs/code) +tiny file dialogs: [homepage](https://sourceforge.net/projects/tinyfiledialogs/) | [primary repo](https://sourceforge.net/p/tinyfiledialogs/code) -Vorbis: [homepage](https://www.xiph.org/vorbis/) | [repo](https://github.com/xiph/vorbis) +Vorbis: [homepage](https://www.xiph.org/vorbis/) | [primary repo](https://github.com/xiph/vorbis) -libvpx: [homepage](https://www.webmproject.org/tools/) | [repo](https://chromium.googlesource.com/webm/libvpx/) | [GitHub mirror](https://github.com/webmproject/libvpx/) +libvpx: [homepage](https://www.webmproject.org/tools/) | [primary repo](https://chromium.googlesource.com/webm/libvpx/) | [GitHub mirror](https://github.com/webmproject/libvpx/) -libwebm: [homepage](https://www.webmproject.org/about/) | [repo](https://chromium.googlesource.com/webm/libwebm) | [GitHub mirror](https://github.com/webmproject/libwebm) +libwebm: [homepage](https://www.webmproject.org/about/) | [primary repo](https://chromium.googlesource.com/webm/libwebm) | [GitHub mirror](https://github.com/webmproject/libwebm) -zlib: [homepage](https://zlib.net/) | [repo](https://github.com/madler/zlib) +zlib: [homepage](https://zlib.net/) | [primary repo](https://github.com/madler/zlib) Overrides --------- The overrides folder contains a number of customized headers and source files, to be used instead of the equivalent file(s) in the submodule. (Or in addition to: some submodules intentionally omit files, expecting the user to generate them.) -All cases require updating the corresponding files.xml file. +All cases require updating the corresponding files.xml file. Since some projects refer to others, you may need to update multiple different files.xml files, and/or [Lime's primary Build.xml file](https://github.com/openfl/lime/blob/develop/project/Build.xml). - To add or override a header, include the overrides folder first (if not already included).