From 9057abaef9f93872e291ab22d8c5a4a6d7ebdd26 Mon Sep 17 00:00:00 2001 From: Aliaksei Chapyzhenka Date: Tue, 28 Jul 2020 12:53:08 -0700 Subject: [PATCH] added circt logo (#57) --- README.md | 18 ++++++++++-------- docs/circt-logo.svg | 9 +++++++++ 2 files changed, 19 insertions(+), 8 deletions(-) create mode 100644 docs/circt-logo.svg diff --git a/README.md b/README.md index a4b709425151..c3bc263242f2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ +

+ [![](https://github.com/circt/circt/workflows/Build%20and%20Test/badge.svg?event=push)](https://github.com/circt/circt/actions) # ⚡️ "CIRCT" / Circuit IR Compilers and Tools "CIRCT" stands for "Circuit IR Compilers and Tools". One might also interpret -it as the recursively as "CIRCT IR Compiler and Tools". The T can be +it as the recursively as "CIRCT IR Compiler and Tools". The T can be selectively expanded as Tool, Translator, Team, Technology, Target, Tree, Type, ... we're ok with the ambiguity. @@ -16,15 +18,15 @@ for more information. The EDA industry has well-known and widely used proprietary and open source tools. However, these tools are inconsistent, have usability concerns, and were not designed together into a common platform. Furthermore -these tools are generally built with -[Verilog](https://en.wikipedia.org/wiki/Verilog) (also +these tools are generally built with +[Verilog](https://en.wikipedia.org/wiki/Verilog) (also [VHDL](https://en.wikipedia.org/wiki/VHDL)) as the IRs that they interchange. Verilog has well known design issues, and limitations, e.g. suffering from poor location tracking support. The CIRCT project is an (experimental!) effort looking to apply MLIR and the LLVM development methodology to the domain of hardware design tools. Many -of us dream of having reusable infrastructure that is modular, uses +of us dream of having reusable infrastructure that is modular, uses library-based design techniques, is more consistent, and builds on the best practices in compiler infrastructure and compiler design techniques. @@ -41,7 +43,7 @@ For more information, please see our longer [charter document](docs/Charter.md). These commands can be used to set this up on a Mac: 1) **Install Dependencies** of LLVM/MLIR according to [the - instructions](https://mlir.llvm.org/getting_started/), including cmake and ninja. + instructions](https://mlir.llvm.org/getting_started/), including cmake and ninja. 2) **Check out LLVM and CIRCT repos.** CIRCT contains LLVM as a git submodule. The LLVM repo here includes staged changes to MLIR which @@ -115,8 +117,8 @@ GitHub issues. Here are some high-level guidelines: * Please use clang-format in the LLVM style. There are good plugins for common editors like VSCode, Atom, etc, or you can run it manually. This makes code easier to read and understand. - - * Beyond mechanical formatting issues, please follow the [LLVM Coding + + * Beyond mechanical formatting issues, please follow the [LLVM Coding Standards](https://llvm.org/docs/CodingStandards.html). * Please practice "[incremental development](https://llvm.org/docs/DeveloperPolicy.html#incremental-development)", preferring to send a small @@ -146,7 +148,7 @@ The patch flow goes like this: 1) Check out the LLVM mono repo (as described above). 2) Make changes to your codebase. 3) Stage your changes with `git add`. -4) Run clang-format to tidy up the details of the patch with `git clang-format origin/master` +4) Run clang-format to tidy up the details of the patch with `git clang-format origin/master` 5) Create a [patch in Phabricator](https://llvm.org/docs/Phabricator.html) with `arc diff`. 6) Iterate on review, changing your code and sending another patch with `arc diff`. diff --git a/docs/circt-logo.svg b/docs/circt-logo.svg new file mode 100644 index 000000000000..d3c7620b7f66 --- /dev/null +++ b/docs/circt-logo.svg @@ -0,0 +1,9 @@ + + + + + + + + +