summaryrefslogtreecommitdiff
path: root/README.md
blob: ff7ad9cede195bda9d29498dbc0cfd99e0016dae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# CHiLL

***The Composable High Level Loop Source-to-Source Translator***

## How to use

### Build

1. checkout repo, cd
2. `cmake -H. -Bbuild`
3. `cmake --build build -- -j10`
4. If no errors during build, executables are in `build`

### Install

1. Optionally set `CMAKE_INSTALL_PREFIX`
2. Optionally `cmake --build build -- install`

## Additional Doc

* doc/CHiLL.pdf
* Doxygen: `cmake --build build -- doc`

## Folder structure

* `src` - CHiLL's "core" source files
* `include` - CHiLL's include files
* `lib` - Included modules, each as its own `src` and `include`
    * `omega` - omega, LICENSE.omega
    * `codegen` - codegen+, without rose dependence, LICENSE.omega
    * `chillcg` - codegen with chill, LICENSE.omega
    * `parserel` - parse Relation vectors, for adding knowns
* `example` - CHiLL example scripts
* `doc` - manual & doxygen

## Debug

* pass `-DDEBUGCHILL` will enable debug output
* or set `-DCMAKE_BUILD_TYPE=DEBUG`