README.md

haxe-clink-externs

1. What is it?
2. Installation
3. Using the latest code
4. License

What is it?

A haxelib with Lua externs for the Clink API to develop custom command line completions for Clink.

Requirements/Limitations

• Haxe Version: 4.2.5 or higher
• Supported Targets: Lua 5.2 vanilla mode, i.e. -D lua_vanilla -D lua_ver=5.2)
• Supported Operating Systems: Windows

Installation

1. install the library via haxelib using the command:

   haxelib install clink-externs
   

2. use in your Haxe project by adding -lib clink-externs to your *.hxml file or as command line option when running the Haxe compiler

Using the latest code

Using haxelib git

haxelib git clink-externs https://github.com/vegardit/haxe-clink-externs main D:\haxe-projects\haxe-clink-externs

Using Git

1. check-out the main branch

   git clone https://github.com/vegardit/haxe-clink-externs --branch main --single-branch D:\haxe-projects\haxe-clink-externs
   

2. register the development release with haxe

   haxelib dev clink-externs D:\haxe-projects\haxe-clink-externs
   

License

All files are released under the MIT License.

Individual files contain the following tag instead of the full license text:

SPDX-License-Identifier: MIT

This enables machine processing of license information based on the SPDX License Identifiers that are available here: https://spdx.org/licenses/.