github.com/gotranspile/cxgo@v0.3.7/FAQ.md (about)

     1  # Frequently Asked Questions
     2  
     3  ## How to use it?
     4  
     5  Check our [examples](./examples/README.md) section. It will guide you through basic usage patterns as well as a more advanced ones (on real-world projects).
     6  
     7  ## How to fix: "include file not found: xyz.h"?
     8  
     9  This means that `cxgo` was unable to locate the included file.
    10  
    11  Include lookup considers paths in the following order:
    12  
    13  - Directory of the source file: `./xyz.h`
    14  - Local include directory: `./include/xyz.h` (or `./includes/xyz.h`)
    15  - Any user-defined include paths from the config ([`include`](docs/config.md#include) and [`sys_include`](docs/config.md#sys_include))
    16  - Bundled headers from `cxgo`
    17  
    18  Having this in mind you could either:
    19  
    20  - Add a config file [directive](docs/config.md#sys_include): `sys_include: ['/your/path/here']`
    21    (or [`include`](docs/config.md#include) if the file is included as `"xyz.h"` and not `<xyz.h>`)
    22  - Find and copy an included file into `./include`
    23  - If this is a header in question is from a C stdlib, consider [contributing it](CONTRIBUTING.md#adding-a-new-known-header) to `cxgo`
    24  
    25  ## How to add support for a new header file?
    26  
    27  See the corresponding [contribution guide section](CONTRIBUTING.md#adding-a-new-known-header).
    28  
    29  ## How to add support for a new function in existing library?
    30  
    31  See the corresponding [contribution guide section](CONTRIBUTING.md#adding-c-symbol-definitions-to-the-library).