summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2021-07-27Clarify test dependencies in README, add noplugin (#2053)Megan Wachs
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,
2021-07-22MovingAverage3 => MovingSum3 (#2050)Jack Koenig
The example in the README is a sum, not an average.
2021-06-29updated readme to mention verilator dependency (#1984)anniej-sifive
* added to readme * Update README.md Co-authored-by: Jack Koenig <jack.koenig3@gmail.com> Co-authored-by: Jack Koenig <jack.koenig3@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-06-28CCC update (#1982)Jiuyang Liu
2021-06-28Add link to Chisel Breakdown slides to README (#1979)Jack Koenig
2021-06-23CCC info update (#1969)Jiuyang Liu
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-06-21Switch to Github Actions CI Badge (#1967)Jack Koenig
2021-06-14explain sub-projects in README (#1962)Deborah Soung
* explain sub-projects * Update README.md Co-authored-by: Megan Wachs <megan@sifive.com> Co-authored-by: Megan Wachs <megan@sifive.com>
2021-06-02CCC schedule update (#1947)Jiuyang Liu
2021-04-26Fix Gitter link in README (#1879)Jack Koenig
2021-04-21Add a link to the Chisel book (#1872)Martin Schoeberl
2021-04-15update CCC2021 info (#1861)Jiuyang Liu
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-04-01Fix Gitter chat room link (#1848)XinJun Ma
2021-03-27CCC 2021 placeholder (#1794)Jiuyang Liu
* Add CCC2021 info * Update README.md * Update README.md
2021-03-18Reorganize website docs (#1806)Megan Wachs
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
2021-01-06Update meeting url (#1716)Jiuyang Liu
2020-12-02readme: simplify sbt snippet and update to the latest stable release (#1686)Kevin Laeufer
2020-11-24Update some README links to chipsalliance (#1673)Jack Koenig
2020-10-26Fixed broken link to type hierarchy diagram (#1611)PENGUINLIONG
Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-09-04Better Building of FIRRTL From Source (#1563)Jack Koenig
Using JVM system properties sbt.sourcemode and sbt.workspace, one can now easily build chisel3 with firrtl from source Example use: Assuming firrtl is cloned into the chisel3 root directory: $ sbt -Dsbt.sourcemode=true -Dsbt.workspace=$PWD Alternatively, one can set these properties in .sbtopts which can then be committed, enabling building from source by default
2020-08-27Update README.md (#1570)Martin Schoeberl
A quick fix for the developer's confusion
2020-08-21Added website docs and mdoc. (#1560)Adam Izraelevitz
* Added website docs and mdoc. Removed all warnings * Updated README and added build to circle ci * Added how to build documentation, deprecated wiki * Fix copypasta Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-07-29Update build instructions in README (#1524)Josh Bassett
The instructions for building Chisel locally didn't include anything about firrtl or treadle. The steps are: 1. publishLocal current working copy of FIRRTL 2. publishLocal current working copy of Treadle 3. sbt test in chisel3
2020-07-13Update Development Meetings info (#1511)Jack Koenig
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-05-04README: add link to website source (#1420)Megan Wachs
2020-03-24Update README.md to reference ChiselStageSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2020-02-19Upcoming Events: Remove CCC, add Dev Meetings (#1345)Schuyler Eldridge
* Remove CCC Upcoming Event Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Add developer meetings as upcoming events Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2020-02-08README: have a link to the classic tutorial (#1325)Martin Schoeberl
2019-11-29Update README to reflect CCC20 ExtensionSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-11-21Add CCC20 Info at README top (#1243)Schuyler Eldridge
* Add CCC20 Info at README top Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Add Upcoming Events h2 Heading to README.md Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-11-12Add brief description of (current) chisel versioning and version ↵Jim Lawson
recommendations. (#1180) * Add brief description of (current) chisel versioning and version recommendations. * Respond to comments. Replace "semantic versioning" with "a form of semantic versioning". * Respond to comments - replace mmddyy with yyyymmdd. * Mention change in SNAPSHOT naming.
2019-09-26More README.md fixesSchuyler Eldridge
- Scaladoc for "latest" is 2.11, so use a 2.11-style link - Use full path for SETUP.md - Switch migration guide to point to website version over wiki Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-25Use raw link for FIR filterSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-25Simplify data types README descriptionSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-25Use full URL links for imagesSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-25Use line instead of empty H1 in README.mdSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-09Switch to new API linksSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-09-08Add Chisel Cheatsheet Latest Release LinkSchuyler Eldridge
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
2019-08-08Update website references to the new websiteAdam Izraelevitz
2019-08-01Fix shift register in READMEAdam Izraelevitz
2019-07-16Fix typo in README.md (#1123)Henry Cook
2019-06-19First crack at updating the readme (#1106)Chick Markley
* First crack at updating the readme Goals Include up front example Simplify Get users to things quicker Move complicated details to wiki. * headers were not working, intellij and github don't use same render for .md files * Fix verb agreement * Add a fir filter diagram Compact the fir-filter code a bit * More compact filter * Additional README.md updates Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Don't use chisel-lang.org, drop HCL Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Fix link to fir image, make it relative * Proposed readme changes * Resize picture, restyle doc bullets
2019-03-20Replace textual release version with Shields SemVer badge. (#1043)Jim Lawson
* Replace textual release version with Shields SemVer badge. * Provide useful button action for release badge.
2019-03-13Update recommended verilator version to 4.006 (#1032)Jim Lawson
2019-02-19Update README to reference the bootcamp (#1025)Paul Rigge
* Update README to reference the bootcamp * Place learning section higher
2018-12-23Add Windows setup instructions to readme (#964)Richard Lin
2018-11-21Update description given that Chisel3 has been released (#948)edwardcwang
Now that Chisel3 has been released, you only need local Chisel to use the master branch in a project.
2018-11-13Add Chisel logo to README (#935)Albert Magyar
2018-11-02Add CircleCI status badge to READMEJim Lawson
2018-09-13Bump version reference in README.md (#888)Jim Lawson
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-01 07:08:55 +0000