                   Codee 2026.1
========================================================
https://www.codee.com/

Codee is a suite of command-line tools aimed at helping software developers to
build better quality parallel software in less time.
Designed around the needs of developers, Codee provides the appropriate tools
for the key stages of the parallel development workflow, aiding developers with
code analysis that would otherwise be error-prone and completed manually.


Contents
--------

bin/
  codee        - High-level overviews and reports of your code, in-depth
                 analyses to improve the performance of your loops, and
                 rewriting functionality using OpenMP, OpenACC, and
                 compiler-specific directives
lib/
docs/
catalog/
  Benchmark/   - A library to demonstrate the speedup attainable with the
                 checkers automated by Codee
  Checks/      - Examples of the checkers (defects, recommendations, and
                 remarks) supported by Codee
  Glossary/    - A Glossary of terms pervasively used in Codee


Installation
------------

1) Place the contents in your desired location and add bin/ to your PATH.
2) Store your license file named as 'codee.lic' inside the root folder (ie. the
   folder containing the bin/, lib/ and other subfolders). Alternatively, you
   can specify its location through the CODEE_LICENSE_PATH environment variable.


More information
----------------

Visit our official documentation site for quickstart guides, examples, and
detailed information to get you up and running with Codee:
https://docs.codee.com/

Pass the --help argument to any tool to get information about its usage.

Take a look at the documents contained in the docs/ folder for details on
specific subjects.

Visit our Open Catalog of Best Practices for Correctness, Modernization,
Security, Portability, and Optimization to get in-depth information about checks
and patterns:
https://open-catalog.codee.com/

Check out our blog posts regarding Codee:
https://www.codee.com/tag/codee/

By using this software you agree to the End User License Agreement contained in
the EULA.txt and EULA_Formatter.txt files. Third-party licenses information is
available in the Third_Party_Licenses.txt file.

Codee is also packaged with the `bear` (https://github.com/rizsotto/Bear)
project to facilitate the creation of compilation databases. License information
regarding its redistribution can be found in the `Bear_Licenses.txt` file. The
source code with all modifications included can be found in the `src/`
directory.

Codee uses SQLite as an underlying data engine. No third‑party copyright
notices or attributions are included, as SQLite's source code is released to
the public domain. We gratefully acknowledge the SQLite project for making this
engine available.
