@@ -9,7 +9,29 @@ For examples of the former, `qtil` has conveniences such as string escaping. For
99
1010Let's dive in!
1111
12- ## Installing and using qtil
12+ ## License
13+
14+ This project is licensed under the terms of the MIT open source license. Please refer to [ MIT] ( ./LICENSE.txt ) for the full terms.
15+
16+ CodeQL is subject to the [ GithHub CodeQL Terms & Conditions] ( https://securitylab.github.com/tools/codeql/license ) .
17+
18+ ## Background
19+
20+ This pack is just a collection of useful ideas, and no specific new features are currently planned.
21+ If you have an idea on how to make writing CodeQL queries easier, please open an issue or a pull
22+ request! And make sure to check back in on occasion to see what new features may have been added.
23+
24+ ## Requirements
25+
26+ To use this library, you should have the CodeQL CLI installed, and a license to use CodeQL on your
27+ project (it is free for open source). For writing queries, we recommend using the
28+ [ VsCode CodeQL starter workspace] ( https://github.com/github/vscode-codeql-starter ) and using the
29+ CodeQL vscode extension.
30+
31+ Once a query development is up and running, you are ready to install ` qtil ` with the instructions
32+ below.
33+
34+ ### Installing and using qtil
1335
1436To install ` qtil ` for CodeQL development, add the following dependency to the ` qlpack.yml ` for your project:
1537
@@ -523,3 +545,18 @@ module MyModule<Qtil::FiniteType A, Qtil::FiniteType B> { ... }
523545 - ` Qtil::InfiniteStringableType ` : Any finite or infinite class, with ` bindingset[this] ` ,
524546 Supports primitives. Does not support ` newtype ` .
525547 - ` Qtil::StringlikeType ` : Any type that extends or is an instanceof ` string ` .
548+
549+ ## Support
550+
551+ This project is intended to be useful and help the CodeQL community. That said, we may not have
552+ time and resources to support every feature request or bug report, and when support is offered it
553+ may be subject to some delay.
554+
555+ If you have a feature request or bug report that is of significant importance to you, please do make
556+ its importance and urgency clear in your issue or pull request, to increase the likelihood of
557+ receiving timely support amidst our busy jobs here at GitHub!
558+
559+ ## Maintainers
560+
561+ This project is currently maintained by @michaelrfairhurst with help from other CodeQL/security
562+ experts at GitHub.
0 commit comments