diff options
| author | Neil <nyamatongwe@gmail.com> | 2019-12-13 22:28:13 +1100 |
|---|---|---|
| committer | Neil <nyamatongwe@gmail.com> | 2019-12-13 22:28:13 +1100 |
| commit | 38e4d3cbc591f06a6663d6c0962bc17ea73d61ad (patch) | |
| tree | 83ee4102d4d9a7c7d92c308d06bfe0459588892a /lexilla/src/README | |
| parent | a8141c4c11ad77014802d003d649abc8335a4f70 (diff) | |
| download | scintilla-mirror-38e4d3cbc591f06a6663d6c0962bc17ea73d61ad.tar.gz | |
Lexilla implemented as loadable lexer.
Diffstat (limited to 'lexilla/src/README')
| -rw-r--r-- | lexilla/src/README | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/lexilla/src/README b/lexilla/src/README new file mode 100644 index 000000000..3ccc4bad1 --- /dev/null +++ b/lexilla/src/README @@ -0,0 +1,42 @@ +README for Lexilla library.
+
+The Lexilla library contains a set of lexers and folders that provides support for
+programming, mark-up, and data languages for the Scintilla source code editing
+component.
+
+Lexilla is made available as both a shared library and static library.
+The shared library is called lexilla.so / lexilla.dylib / lexilla.dll on Linux / macOS /
+Windows.
+The static library is called liblexilla.a when built with GCC or Clang and liblexilla.lib
+when built with MSVC.
+
+Lexilla is developed on Windows, Linux, and macOS and requires a C++17 compiler.
+It may work on other Unix platforms like BSD but that is not a development focus.
+MSVC 2019.4, GCC 9.0, Clang 9.0, and Apple Clang 11.0 are known to work.
+
+MSVC is only available on Windows.
+
+GCC and Clang work on Windows and Linux.
+
+On macOS, only Apple Clang is available.
+
+To use GCC, run lexilla/src/makefile:
+ make
+
+To use Clang, run lexilla/test/makefile:
+ make CLANG=1
+On macOS, CLANG is set automatically so this can just be
+ make
+
+To use MSVC, run lexilla/test/lexilla.mak:
+ nmake -f lexilla.mak
+
+To build a debugging version of the library, add DEBUG=1 to the command:
+ make DEBUG=1
+
+The built libraries are copied into scintilla/bin.
+
+Lexilla relies on a list of lexers from the scintilla/lexers directory. If any changes are
+made to the set of lexers then source and build files can be regenerated with the
+lexilla/scripts/LexillaGen.py script which requires Python 3 and is tested with 3.7+.
+ python LexillaGen.py
|