# About Scintilla

## Source

The vendored Scintilla source code is fetched from their official website [^1]. Version is 5.5.2. All vendored code are inside the `scintilla` folder.

[^1]: https://www.scintilla.org/ScintillaDownload.html

## How to update

To update the vendored code to the newer version, do the following steps.

1. Download the ZIP archive of the new version, unzip it and replace the `scintilla` folder.
2. Under `scintilla/qt/ScintillaEdit`, run `WidgetGen.py` to generate `ScintillaEdit.h` and `ScintillaEdit.cpp`.
3. Reconfigure project, start to build, and see if it fails. If so, review the change of `ScintillaEdit.pro` and see if we need to update the `CMakeLists.txt` in this folder (along with this `README.md` file).
4. Done, we can commit the change now.

The folder name that this sub-project lives at currently indicates the Scintilla version that we uses. If updated, consider also update the folder name as well.

The Lexilla project also depends on Scintilla's include files, so Lexilla's `CMakeLists.txt` also needs to be updated if the folder name changed.