Skip to content

Commit

Permalink
misc: further streamline the header of our README (#319)
Browse files Browse the repository at this point in the history
- Drop 'about' header and inline the content right at the top
- Move the badges before the first header
- Move TOC after the 'about' part
  • Loading branch information
tobiasgrosser committed Jan 11, 2023
1 parent 66fd1c8 commit 66cfc53
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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,
Expand Down Expand Up @@ -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.
save.

0 comments on commit 66cfc53

Please sign in to comment.