The Official Khronos KTX Software Repository

	master	incoming
GNU/Linux, iOS & OSX
Windows
Documentation		-

This is the offical home of the source code for the Khronos KTX library and tools. KTX is a lightweight file format for OpenGL textures, designed around how textures are loaded in OpenGL.

See the Doxygen generated live documentation for API usage information. Because CodeDocs does not yet support multiple branches, only master/HEAD is available.

IMPORTANT: The API in reader.c for opening a KTX file and reading its images is subject to change. That is why it is not yet in master.

See CONTRIBUTING for information about contributing.

See LICENSE for information about licensing.

See BUILDING for information about building the code.

More information about KTX and links to tools that support it can be found on the KTX page of the OpenGL ES SDK on khronos.org.

If you need help with using the KTX library or KTX tools, please use the KTX forum. To report problems use GitHub issues.

IMPORTANT: you must install the Git LFS command line extension in order to fully checkout this repository after cloning. You need at least version 1.1.

A few files have $Date$ keywords. If you care about having the proper dates shown or will be generating the documentation or preparing distribution archives, you must follow the instructions below.

$Date$ keyword expansion

$Date$ keywords are expanded via a smudge & clean filter. To install the filter, issue the following commands in the root of your clone.

On Unix (Linux, Mac OS X, etc.) platforms and Windows using Git for Windows' Git Bash or Cygwin's bash terminal:

./install-gitconfig.sh
rm TODO.md include/ktx.h tools/toktx/toktx.cpp
git checkout TODO.md include/ktx.h tools/toktx/toktx.cpp

On Windows with the Command Prompt (requires git.exe in a directory on your %PATH%):

install-gitconfig.bat
del TODO.md include/ktx.h tools/toktx/toktx.cpp
git checkout TODO.md include/ktx.h tools/toktx/toktx.cpp 

The first command adds an [include] of the repo's .gitconfig to the local git config file .git/config, i.e. the one in your clone of the repo. .gitconfig contains the config of the "keyworder" filter. The remaining commands force a new checkout of the affected files to smudge them with the date. These two are unnecessary if you plan to edit these files.