diff --git a/README.md b/README.md index 3be3702b6e..e5b0026ce0 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,9 @@ -# xDSL: A Python-native SSA Compiler Framework - [![Build Status for the Core backend](https://github.com/xdslproject/xdsl/actions/workflows/ci-core.yml/badge.svg)](https://github.com/xdslproject/xdsl/actions/workflows/ci-core.yml?query=workflow%3A%22CI+-+Python+application%22++) [![PyPI version](https://badge.fury.io/py/xdsl.svg)](https://badge.fury.io/py/xdsl) [![Code Coverage](https://codecov.io/gh/xdslproject/xdsl/main/graph/badge.svg)](https://codecov.io/gh/xdslproject/xdsl) [![Zulip Status](https://img.shields.io/badge/chat-on%20zulip-%2336C5F0)](https://xdsl.zulipchat.com) -- [xDSL: A Python-native SSA Compiler Framework](#xdsl-a-python-native-ssa-compiler-framework) - - [About xDSL](#about-xdsl) - - [Installation](#installation) - - [Using xDSL](#using-xdsl) - - [xDSL Developer Setup](#xdsl-developer-setup) - - [Developer Installation](#developer-installation) - - [Testing](#testing) - - [Formatting](#formatting) - -## About xDSL +# xDSL: A Python-native SSA Compiler Framework [xDSL](http://www.xdsl.dev) is a Python-native compiler framework built around SSA-based intermediate representations (IRs). Users of xDSL build a compiler by @@ -35,6 +24,13 @@ through Python, making analysis through simple scripting languages possible. Additionally, xDSL can leverage MLIR's code generation and low-level optimization capabilities. +- [Installation](#installation) +- [Using xDSL](#using-xdsl) +- [xDSL Developer Setup](#xdsl-developer-setup) + - [Developer Installation](#developer-installation) + - [Testing](#testing) + - [Formatting](#formatting) + ## Installation To use xDSL as part of a larger project for developing your own compiler, @@ -89,4 +85,4 @@ format the code in a uniform manner. To automate the formatting within vim, one can use https://github.com/vim-autoformat/vim-autoformat and trigger a `:Autoformat` on -save. \ No newline at end of file +save.