From 64bbab8d890439afa0529a8d8750cd4ed223f2e4 Mon Sep 17 00:00:00 2001 From: Henrich Lauko Date: Thu, 9 Nov 2023 22:00:22 +0100 Subject: [PATCH] docs: Add getting started section. --- docs/{ => GettingStarted}/build.md | 0 docs/GettingStarted/extend.md | 9 +++++++++ 2 files changed, 9 insertions(+) rename docs/{ => GettingStarted}/build.md (100%) create mode 100644 docs/GettingStarted/extend.md diff --git a/docs/build.md b/docs/GettingStarted/build.md similarity index 100% rename from docs/build.md rename to docs/GettingStarted/build.md diff --git a/docs/GettingStarted/extend.md b/docs/GettingStarted/extend.md new file mode 100644 index 0000000000..71e8994cf7 --- /dev/null +++ b/docs/GettingStarted/extend.md @@ -0,0 +1,9 @@ +## How to Start Extending VAST? + +VAST offers a handy script to generate a variety of MLIR primitives. You can find the script at scripts/templater.py. This tool is designed to help you create dialects, passes, operations, types, and attributes interactively. + +### Usage + +Just run the script. It has been designed to provide a guided process for generating the desired primitives. If you find anything confusing or unintuitive, please don't hesitate to open an issue so that we can address it. + +When you run the script, it will generate the basic skeleton for your chosen primitive. It will list the generated files which you can freely modify to provide desired functionality.