Skip to content

Commit 6bc9b15

Browse files
committed
[llvm][TableGen][Jupyter] Add notebook links to README
This folder contains the kernel and notebooks so let's make that obvious and list them in the readme.
1 parent 1d6d1ec commit 6bc9b15

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

llvm/utils/TableGen/jupyter/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
# A Jupyter kernel for TableGen (llvm-tblgen)
1+
# Jupyter Tools for TableGen
2+
3+
This folder contains notebooks relating to TableGen and a Jupyter kernel for
4+
TableGen.
5+
6+
## Notebooks
7+
8+
[LLVM_TableGen.ipynb](LLVM_TableGen.ipynb) - A demo of the kernel's capabilities.
9+
10+
[sql_query_backend.ipynb](sql_query_backend.ipynb) - How to write a backend using
11+
JSON output and Python.
12+
13+
Notebooks can be viewed in browser on Github or downloaded and run locally. If
14+
that is not possible, there are Markdown versions next to the notebook files.
15+
16+
## TableGen Kernel
217

318
To use the kernel, first install it into jupyter:
419

@@ -23,9 +38,6 @@ Then run one of:
2338
jupyter console --kernel tablegen
2439
```
2540

26-
If you just want to see the results of the notebook, you can read
27-
[`LLVM_TableGen.md`](LLVM_TableGen.md) instead.
28-
2941
`llvm-tblgen` is expected to be either in the `PATH` or you can set
3042
the environment variable `LLVM_TBLGEN_EXECUTABLE` to point to it directly.
3143

0 commit comments

Comments
 (0)