From f1ad5b58e8a749d558758288d03ce75bf6b8ff9c Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Thu, 18 Mar 2021 16:47:58 -0700 Subject: Reorganize website docs (#1806) Updates to chisel3 documentation for website: * guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README * fix tabbing and compile of chisel3-vs-chisel2 section * Appendix: faqs now guarded and compile * FAQs: move to resources section--- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9abe18f4..b9298520 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,6 @@ These simulation-based verification tools are available for Chisel: ### Useful Resources - [**Cheat Sheet**](https://github.com/freechipsproject/chisel-cheatsheet/releases/latest/download/chisel_cheatsheet.pdf), a 2-page reference of the base Chisel syntax and libraries -- [**Wiki**](https://github.com/chipsalliance/chisel3/wiki), which contains various feature-specific tutorials and frequently-asked questions. - [**ScalaDoc**](https://www.chisel-lang.org/api/latest/chisel3/index.html), a listing, description, and examples of the functionality exposed by Chisel - [**Gitter**](https://gitter.im/chipsalliance/chisel3), where you can ask questions or discuss anything Chisel - [**Website**](https://www.chisel-lang.org) ([source](https://github.com/freechipsproject/www.chisel-lang.org/)) -- cgit v1.2.3 From 7b8fbbe8913a2eb92f50948dc2be50dc482fb58d Mon Sep 17 00:00:00 2001 From: Jiuyang Liu Date: Sat, 27 Mar 2021 03:04:51 +0000 Subject: CCC 2021 placeholder (#1794) * Add CCC2021 info * Update README.md * Update README.md--- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index b9298520..04aaf81f 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,20 @@ ## Upcoming Events +### Chisel Dev Meeting Chisel/FIRRTL development meetings happen every Monday and Tuesday from 1100--1200 PT. Call-in info and meeting notes are available [here](https://docs.google.com/document/d/1BLP2DYt59DqI-FgFCcjw8Ddl4K-WU0nHmQu0sZ_wAGo/). +### Chisel Community Conference 2021, Shanghai, China. 6/24/2021 +The ShanghaiTech University and Institute of Software, Chinese Academy of Sciences will hold the first annual RISC-V Summit China (https://riscvsummitchina.github.io/) at the ShanghaiTech Zhangjiang campus from June 22 to 24, 2021, and the Chisel Community Conference will follow this conference from June 25 to 26, 2021. + +This Summit is the annual international event promoting Chisel, the new hardware design language that facilitates advanced circuit generation and design reuse for both ASIC and FPGA digital logic designs. This conference brings together the new experience from community and industry with tutorials, exhibitions, and more. + +This year’s conference program will demonstrate exciting new features of Chisel and amazing projects implemented by Chisel/FIRRTL. The call for speakers for the Chisel Summit is open from Monday, March 29 and speakers will be notified in late April or early May. + +CFP Link will be updated soon. + --- [![Join the chat at https://gitter.im/chipsalliance/chisel3](https://badges.gitter.im/chipsalliance/chisel3.svg)](https://gitter.im/chipsalliance/chisel3?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -- cgit v1.2.3 From d3e2b346d4edfb3f380e4d8dbfc96b540791275e Mon Sep 17 00:00:00 2001 From: XinJun Ma Date: Thu, 1 Apr 2021 22:38:24 +0800 Subject: Fix Gitter chat room link (#1848) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 04aaf81f..a283a68c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ CFP Link will be updated soon. --- -[![Join the chat at https://gitter.im/chipsalliance/chisel3](https://badges.gitter.im/chipsalliance/chisel3.svg)](https://gitter.im/chipsalliance/chisel3?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Join the chat at https://gitter.im/freechipsproject/chisel3](https://badges.gitter.im/chipsalliance/chisel3.svg)](https://gitter.im/freechipsproject/chisel3?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![CircleCI](https://circleci.com/gh/chipsalliance/chisel3/tree/master.svg?style=shield)](https://circleci.com/gh/chipsalliance/chisel3/tree/master) [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/chipsalliance/chisel3.svg?label=release)](https://github.com/chipsalliance/chisel3/releases/latest) -- cgit v1.2.3 From 0cc35a26d29b24b9c876afd875fe3cb1ef24056c Mon Sep 17 00:00:00 2001 From: Jiuyang Liu Date: Fri, 16 Apr 2021 03:49:45 +0800 Subject: update CCC2021 info (#1861) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>--- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 54 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a283a68c..0c608a15 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,61 @@ Chisel/FIRRTL development meetings happen every Monday and Tuesday from 1100--12 Call-in info and meeting notes are available [here](https://docs.google.com/document/d/1BLP2DYt59DqI-FgFCcjw8Ddl4K-WU0nHmQu0sZ_wAGo/). ### Chisel Community Conference 2021, Shanghai, China. 6/24/2021 -The ShanghaiTech University and Institute of Software, Chinese Academy of Sciences will hold the first annual RISC-V Summit China (https://riscvsummitchina.github.io/) at the ShanghaiTech Zhangjiang campus from June 22 to 24, 2021, and the Chisel Community Conference will follow this conference from June 25 to 26, 2021. -This Summit is the annual international event promoting Chisel, the new hardware design language that facilitates advanced circuit generation and design reuse for both ASIC and FPGA digital logic designs. This conference brings together the new experience from community and industry with tutorials, exhibitions, and more. - -This year’s conference program will demonstrate exciting new features of Chisel and amazing projects implemented by Chisel/FIRRTL. The call for speakers for the Chisel Summit is open from Monday, March 29 and speakers will be notified in late April or early May. - -CFP Link will be updated soon. +The Chisel Community Conference China 2021 (CCC2021) is planned for June 25, +2021 at the ShanghaiTech University. CCC is an annual gathering of Chisel +community enthusiasts and technical exchange workshop. +With the support of the Chisel development community, this conference will +bring together designers and developers with hands-on experience in Chisel +from home and abroad to share cutting-edge results and experiences from the +open source community and industry. + +Session topics include and are not limited to +* CPU Core (recommended but not restricted to RISC-V) implementations +* SoC implementations +* Verification +* Simulation +* Synthesis +* Education +* Experience sharing + +Types of manuscripts. +* Technical Presentations: case studies or problem-oriented presentations on +original research, breakthrough ideas, or insights into future trends. +Sessions should provide specific examples and include both practical and +theoretical information. The length of time is about 20 minutes. +* Lightning talks: 5 to 10 minutes, either pre-registered or on-site (depending +on the time of the conference), can present and promote a specific Chisel +project. + +The presentation submission language is required to be in English, and both +English and Chinese are acceptable for the presentation language. +Reviewers (subject to change at that time). +* Jack Koenig +* Adam Izraelevitz +* Edward Wang +* Jiuyang Liu + +Key Timeline. +Submission deadline: April 25, 2021 +Manuscript topics and abstracts should be submitted by the submission +deadline, and will be reviewed and selected by Chisel developers. +Notification of acceptance: by May 12, 2021 +Final manuscript deadline: May 30, 2021 +A full version of the manuscript should be submitted by the final deadline, and +Chisel developers will quality review and suggest final changes. + +Mail submission method. +``` +Subject: - [CCC] Your Topic +CC: Jiuyang Liu +CC: Jack Koenig +CC: Adam Izraelevitz +CC: Edward Wang +Body: Abstract of your paper. +Attachment: pdf only slides +All submissions are welcome. +``` --- -- cgit v1.2.3 From da5e5cb512cc9249a58b951f750b63707c1c8d83 Mon Sep 17 00:00:00 2001 From: Martin Schoeberl Date: Wed, 21 Apr 2021 20:36:28 +0200 Subject: Add a link to the Chisel book (#1872) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0c608a15..bd782aec 100644 --- a/README.md +++ b/README.md @@ -156,6 +156,10 @@ The [**online Chisel Bootcamp**](https://mybinder.org/v2/gh/freechipsproject/chi The [**classic Chisel tutorial**](https://github.com/ucb-bar/chisel-tutorial) contains small exercises and runs on your computer. +### A Textbook on Chisel + +If you like a textbook to learn Chisel and also a bit of digital design in general, you may be interested in reading [**Digital Design with Chisel**](http://www.imm.dtu.dk/~masca/chisel-book.html). It is available in English, Chinese, Japanese, and Vietnamese. + ### Build Your Own Chisel Projects See [the setup instructions](https://github.com/chipsalliance/chisel3/blob/master/SETUP.md) for how to set up your environment to run Chisel locally. -- cgit v1.2.3 From 804271ea9bae61998811de0de42e476178ed8f75 Mon Sep 17 00:00:00 2001 From: Jack Koenig Date: Mon, 26 Apr 2021 12:00:34 -0700 Subject: Fix Gitter link in README (#1879) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index bd782aec..1d91840a 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ These simulation-based verification tools are available for Chisel: - [**Cheat Sheet**](https://github.com/freechipsproject/chisel-cheatsheet/releases/latest/download/chisel_cheatsheet.pdf), a 2-page reference of the base Chisel syntax and libraries - [**ScalaDoc**](https://www.chisel-lang.org/api/latest/chisel3/index.html), a listing, description, and examples of the functionality exposed by Chisel -- [**Gitter**](https://gitter.im/chipsalliance/chisel3), where you can ask questions or discuss anything Chisel +- [**Gitter**](https://gitter.im/freechipsproject/chisel3), where you can ask questions or discuss anything Chisel - [**Website**](https://www.chisel-lang.org) ([source](https://github.com/freechipsproject/www.chisel-lang.org/)) If you are migrating from Chisel2, see [the migration guide](https://www.chisel-lang.org/chisel3/chisel3-vs-chisel2.html). -- cgit v1.2.3 From ac31c62e4360aedca97605b7fe4471c8611051f3 Mon Sep 17 00:00:00 2001 From: Jiuyang Liu Date: Wed, 2 Jun 2021 13:22:57 +0800 Subject: CCC schedule update (#1947) --- README.md | 61 +++++-------------------------------------------------------- 1 file changed, 5 insertions(+), 56 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1d91840a..91aef6b6 100644 --- a/README.md +++ b/README.md @@ -9,62 +9,11 @@ Chisel/FIRRTL development meetings happen every Monday and Tuesday from 1100--12 Call-in info and meeting notes are available [here](https://docs.google.com/document/d/1BLP2DYt59DqI-FgFCcjw8Ddl4K-WU0nHmQu0sZ_wAGo/). -### Chisel Community Conference 2021, Shanghai, China. 6/24/2021 - -The Chisel Community Conference China 2021 (CCC2021) is planned for June 25, -2021 at the ShanghaiTech University. CCC is an annual gathering of Chisel -community enthusiasts and technical exchange workshop. -With the support of the Chisel development community, this conference will -bring together designers and developers with hands-on experience in Chisel -from home and abroad to share cutting-edge results and experiences from the -open source community and industry. - -Session topics include and are not limited to -* CPU Core (recommended but not restricted to RISC-V) implementations -* SoC implementations -* Verification -* Simulation -* Synthesis -* Education -* Experience sharing - -Types of manuscripts. -* Technical Presentations: case studies or problem-oriented presentations on -original research, breakthrough ideas, or insights into future trends. -Sessions should provide specific examples and include both practical and -theoretical information. The length of time is about 20 minutes. -* Lightning talks: 5 to 10 minutes, either pre-registered or on-site (depending -on the time of the conference), can present and promote a specific Chisel -project. - -The presentation submission language is required to be in English, and both -English and Chinese are acceptable for the presentation language. -Reviewers (subject to change at that time). -* Jack Koenig -* Adam Izraelevitz -* Edward Wang -* Jiuyang Liu - -Key Timeline. -Submission deadline: April 25, 2021 -Manuscript topics and abstracts should be submitted by the submission -deadline, and will be reviewed and selected by Chisel developers. -Notification of acceptance: by May 12, 2021 -Final manuscript deadline: May 30, 2021 -A full version of the manuscript should be submitted by the final deadline, and -Chisel developers will quality review and suggest final changes. - -Mail submission method. -``` -Subject: - [CCC] Your Topic -CC: Jiuyang Liu -CC: Jack Koenig -CC: Adam Izraelevitz -CC: Edward Wang -Body: Abstract of your paper. -Attachment: pdf only slides -All submissions are welcome. -``` +### Chisel Community Conference 2021, Shanghai, China. 6/26/2021(CST) +The Chisel Community Conference China 2021 (CCC2021) is planned for June 26, 2021(CST) at the ShanghaiTech University. The schedule is available [here](https://docs.google.com/spreadsheets/d/1Gb4mMGRhs9exJW-l3NOS0IFi7fDplNQQnkXyAKzHlTg) +CCC is an annual gathering of Chisel community enthusiasts and technical exchange workshop. With the support of the Chisel development community and RISC-V World Conference China 2021 Committee, this conference will bring together designers and developers with hands-on experience in Chisel from home and abroad to share cutting-edge results and experiences from both the open source community as well as industry. +Online signup is not required. Zoom/YouTube/BiliBili streaming links will be added to the schedule before the start of the conference. +Offline signup [link](https://www.bagevent.com/event/registerTicket/7314534), Due to COVID-19 restrictions, offline registration is open only to current residents already present in mainland China. --- -- cgit v1.2.3 From ea84a17691c1fbea81644788b78699702c8faaf3 Mon Sep 17 00:00:00 2001 From: Deborah Soung Date: Mon, 14 Jun 2021 15:34:45 -0700 Subject: explain sub-projects in README (#1962) * explain sub-projects * Update README.md Co-authored-by: Megan Wachs Co-authored-by: Megan Wachs --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 91aef6b6..9aba4e8a 100644 --- a/README.md +++ b/README.md @@ -243,6 +243,17 @@ Also included is: - **Chisel Stage**, `chisel3.stage.*`, which contains compilation and test functions that are invoked in the standard Verilog generation and simulation testing infrastructure. These can also be used as part of custom flows. + +### Chisel Sub-Projects + +Chisel consists of 4 Scala projects; each is its own separate compilation unit: + +- [`core`](core) is the bulk of the source code of Chisel, depends on `macros` +- [`src/main`](src/main) is the "main" that brings it all together and includes a [`util`](src/main/scala/chisel3/util) library, which depends on `core` +- [`plugin`](plugin) is the compiler plugin, no internal dependencies +- [`macros`](macros) is most of the macros used in Chisel, no internal dependencies + +Code that touches lots of APIs that are private to the `chisel3` package should belong in `core`, while code that is pure Chisel should belong in `src/main`. ### Which version should I use? -- cgit v1.2.3 From 44c7fca8a303bc787634014502acd835c6b5d334 Mon Sep 17 00:00:00 2001 From: Jack Koenig Date: Mon, 21 Jun 2021 13:36:13 -0700 Subject: Switch to Github Actions CI Badge (#1967) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9aba4e8a..8d0ca862 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Offline signup [link](https://www.bagevent.com/event/registerTicket/7314534), Du --- [![Join the chat at https://gitter.im/freechipsproject/chisel3](https://badges.gitter.im/chipsalliance/chisel3.svg)](https://gitter.im/freechipsproject/chisel3?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![CircleCI](https://circleci.com/gh/chipsalliance/chisel3/tree/master.svg?style=shield)](https://circleci.com/gh/chipsalliance/chisel3/tree/master) +![CI](https://github.com/chipsalliance/chisel3/actions/workflows/test.yml/badge.svg) [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/chipsalliance/chisel3.svg?label=release)](https://github.com/chipsalliance/chisel3/releases/latest) [**Chisel**](https://www.chisel-lang.org) is a hardware design language that facilitates **advanced circuit generation and design reuse for both ASIC and FPGA digital logic designs**. -- cgit v1.2.3 From 04de237e91192b884bbc51c78c57932b2ad7754a Mon Sep 17 00:00:00 2001 From: Jiuyang Liu Date: Thu, 24 Jun 2021 00:16:31 +0800 Subject: CCC info update (#1969) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>--- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8d0ca862..b2de88de 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,12 @@ Call-in info and meeting notes are available [here](https://docs.google.com/docu ### Chisel Community Conference 2021, Shanghai, China. 6/26/2021(CST) The Chisel Community Conference China 2021 (CCC2021) is planned for June 26, 2021(CST) at the ShanghaiTech University. The schedule is available [here](https://docs.google.com/spreadsheets/d/1Gb4mMGRhs9exJW-l3NOS0IFi7fDplNQQnkXyAKzHlTg) CCC is an annual gathering of Chisel community enthusiasts and technical exchange workshop. With the support of the Chisel development community and RISC-V World Conference China 2021 Committee, this conference will bring together designers and developers with hands-on experience in Chisel from home and abroad to share cutting-edge results and experiences from both the open source community as well as industry. -Online signup is not required. Zoom/YouTube/BiliBili streaming links will be added to the schedule before the start of the conference. -Offline signup [link](https://www.bagevent.com/event/registerTicket/7314534), Due to COVID-19 restrictions, offline registration is open only to current residents already present in mainland China. +You can join the meeting via streaming links below: +- [Zoom](https://sifive.zoom.us/j/93495528878?pwd=L3IxYkdqWURGVk5pR0hMUDBEM0UzUT09) + Meeting ID: 934 9552 8878 + Passcode: 820268 + +- [BiliBili](http://live.bilibili.com/22275404) --- -- cgit v1.2.3 From a5cfd8bf64a2fb261f15dd2d9ab669839a71c7b1 Mon Sep 17 00:00:00 2001 From: Jack Koenig Date: Mon, 28 Jun 2021 12:49:54 -0700 Subject: Add link to Chisel Breakdown slides to README (#1979) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index b2de88de..b368e139 100644 --- a/README.md +++ b/README.md @@ -151,6 +151,12 @@ These are the base data types for defining circuit components: ## Contributor Documentation This section describes how to get started contributing to Chisel itself, including how to test your version locally against other projects that pull in Chisel using [sbt's managed dependencies](https://www.scala-sbt.org/1.x/docs/Library-Dependencies.html). +### Useful Resources for Contributors + +The [Useful Resources](#useful-resources) for users are also helpful for contributors. + +- [**Chisel Breakdown Slides**](https://docs.google.com/presentation/d/114YihixFBPCfUnv1inqAL8UjsiWfcNWdPHX7SeqlRQc), an introductory talk about Chisel's internals + ### Compiling and Testing Chisel First, clone and build the master branch of [FIRRTL](https://github.com/chipsalliance/firrtl) and [Treadle](https://github.com/chipsalliance/treadle), as the master branch of Chisel may depend on unreleased changes in those projects: -- cgit v1.2.3 From 6a806918b15d78613638c8d860538adbef9425b1 Mon Sep 17 00:00:00 2001 From: Jiuyang Liu Date: Tue, 29 Jun 2021 04:28:20 +0800 Subject: CCC update (#1982) --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b368e139..2cf78760 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,11 @@ Chisel/FIRRTL development meetings happen every Monday and Tuesday from 1100--12 Call-in info and meeting notes are available [here](https://docs.google.com/document/d/1BLP2DYt59DqI-FgFCcjw8Ddl4K-WU0nHmQu0sZ_wAGo/). -### Chisel Community Conference 2021, Shanghai, China. 6/26/2021(CST) -The Chisel Community Conference China 2021 (CCC2021) is planned for June 26, 2021(CST) at the ShanghaiTech University. The schedule is available [here](https://docs.google.com/spreadsheets/d/1Gb4mMGRhs9exJW-l3NOS0IFi7fDplNQQnkXyAKzHlTg) -CCC is an annual gathering of Chisel community enthusiasts and technical exchange workshop. With the support of the Chisel development community and RISC-V World Conference China 2021 Committee, this conference will bring together designers and developers with hands-on experience in Chisel from home and abroad to share cutting-edge results and experiences from both the open source community as well as industry. -You can join the meeting via streaming links below: -- [Zoom](https://sifive.zoom.us/j/93495528878?pwd=L3IxYkdqWURGVk5pR0hMUDBEM0UzUT09) - Meeting ID: 934 9552 8878 - Passcode: 820268 - -- [BiliBili](http://live.bilibili.com/22275404) +### Chisel Community Conference 2021, Shanghai, China. +CCC is an annual gathering of Chisel community enthusiasts and technical exchange workshop. +This year with the support of the Chisel development community and RISC-V World Conference China 2021 Committee, we have brought together designers and developers with hands-on experience in Chisel from home and abroad to share cutting-edge results and experiences from both the open source community as well as industry. +English translated recordings version will be updated soon. +Looking forward to CCC 2022! See you then! --- -- cgit v1.2.3 From 8724cd542df2e907069d9ee3fd7d1675a9ca9287 Mon Sep 17 00:00:00 2001 From: anniej-sifive Date: Mon, 28 Jun 2021 19:06:47 -0700 Subject: updated readme to mention verilator dependency (#1984) * added to readme * Update README.md Co-authored-by: Jack Koenig Co-authored-by: Jack Koenig Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>--- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2cf78760..1f302c53 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,9 @@ cd chisel3 sbt compile ``` +In order to run the following unit tests, make sure you have Verilator installed and on your `PATH` +(you can check this by running `which verilator`). + If the compilation succeeded, you can then run the included unit tests by invoking: ``` -- cgit v1.2.3 From 3f007becb8093cbeda66ec0db9f2876553bc0257 Mon Sep 17 00:00:00 2001 From: Jack Koenig Date: Thu, 22 Jul 2021 12:50:50 -0700 Subject: MovingAverage3 => MovingSum3 (#2050) The example in the README is a sum, not an average.--- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1f302c53..1b36d91d 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,8 @@ Consider an FIR filter that implements a convolution operation, as depicted in t While Chisel provides similar base primitives as synthesizable Verilog, and *could* be used as such: ```scala -// 3-point moving average implemented in the style of a FIR filter -class MovingAverage3(bitWidth: Int) extends Module { +// 3-point moving sum implemented in the style of a FIR filter +class MovingSum3(bitWidth: Int) extends Module { val io = IO(new Bundle { val in = Input(UInt(bitWidth.W)) val out = Output(UInt(bitWidth.W)) @@ -52,7 +52,7 @@ class MovingAverage3(bitWidth: Int) extends Module { } ``` -the power of Chisel comes from the ability to create generators, such as n FIR filter that is defined by the list of coefficients: +the power of Chisel comes from the ability to create generators, such as an FIR filter that is defined by the list of coefficients: ```scala // Generalized FIR filter parameterized by the convolution coefficients class FirFilter(bitWidth: Int, coeffs: Seq[UInt]) extends Module { @@ -77,7 +77,7 @@ class FirFilter(bitWidth: Int, coeffs: Seq[UInt]) extends Module { and use and re-use them across designs: ```scala -val movingAverage3Filter = Module(new FirFilter(8, Seq(1.U, 1.U, 1.U))) // same 3-point moving average filter as before +val movingSum3Filter = Module(new FirFilter(8, Seq(1.U, 1.U, 1.U))) // same 3-point moving sum filter as before val delayFilter = Module(new FirFilter(8, Seq(0.U, 1.U))) // 1-cycle delay as a FIR filter val triangleFilter = Module(new FirFilter(8, Seq(1.U, 2.U, 3.U, 2.U, 1.U))) // 5-point FIR filter with a triangle impulse response ``` -- cgit v1.2.3 From e3d245e0bfaf164996fac655b2da0818e1ad37d0 Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Tue, 27 Jul 2021 13:54:44 -0700 Subject: Clarify test dependencies in README, add noplugin (#2053) There are now more tool dependecies than just `verilator` to get the full test suite to pass. Also add instructions for running the tests without the compiler plugin,--- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1b36d91d..d5ddb0fb 100644 --- a/README.md +++ b/README.md @@ -172,15 +172,27 @@ cd chisel3 sbt compile ``` -In order to run the following unit tests, make sure you have Verilator installed and on your `PATH` -(you can check this by running `which verilator`). +In order to run the following unit tests, you will need several tools on your `PATH`, namely +[verilator](https://www.veripool.org/verilator/), +[yosys](http://www.clifford.at/yosys/), +[espresso](https://github.com/chipsalliance/espresso), +and [z3](https://github.com/Z3Prover/z3). +Check that each is installed on your `PATH` by running `which verilator` and so on. -If the compilation succeeded, you can then run the included unit tests by invoking: +If the compilation succeeded and the dependencies noted above are installed, you can then run the included unit tests by invoking: ``` sbt test ``` + + +If you would like to run the tests without the compiler plugin (less common), you can do so by first launching `sbt`, +then running `noPluginTests / test`: +``` +sbt +> noPluginTests / test +``` ### Running Projects Against Local Chisel To use the development version of Chisel (`master` branch), you will need to build from source and `publishLocal`. -- cgit v1.2.3 From 0a985f7d82d33b45bb35237bf3ca85d6f3936600 Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Mon, 30 Aug 2021 07:36:32 -0700 Subject: FIx firrtl typo in README versioning section (#2097) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d5ddb0fb..60d1dae9 100644 --- a/README.md +++ b/README.md @@ -278,7 +278,7 @@ Code that touches lots of APIs that are private to the `chisel3` package should ### Which version should I use? -The chisel eco-system (`chisel3`, `firttl`, `dsptools`, `firrtl-interpreter`, `treadle`, `diagrammer`) use a form of semantic versioning: +The chisel eco-system (`chisel3`, `firrtl`, `dsptools`, `firrtl-interpreter`, `treadle`, `diagrammer`) use a form of semantic versioning: major versions are identified by two leading numbers, separated by a dot (i.e., `3.2`), minor versions by a single number following the major version, separated by a dot. We maintain API compatibility within a major version (i.e., `3.2.12` should be API-compatible with `3.2.0`), but do not guarantee API compatibility between major versions (i.e., APIs may change between `3.1.8` and `3.2.0`). -- cgit v1.2.3