Skip to content

Update README.md for Chisel 5#3093

Merged
jackkoenig merged 1 commit intomainfrom
chisel5-readme
Apr 14, 2023
Merged

Update README.md for Chisel 5#3093
jackkoenig merged 1 commit intomainfrom
chisel5-readme

Conversation

@jackkoenig
Copy link
Contributor

Contributor Checklist

  • [NA] Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • [NA] Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • docs cleanup

API Impact

No impact

Backend Code Generation Impact

No impact

Desired Merge Strategy

  • Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (Bug fix: 3.5.x or 3.6.x depending on impact, API modification or big change: 5.0.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@sequencer
Copy link
Member

I think we need to drop the scastie support for now?

@jerryz123
Copy link
Contributor

Scastie is one of the most useful links on this page. Keeping around a link to a scastie for a prior chisel version would be great.

@sequencer
Copy link
Member

Scastie is one of the most useful links on this page. Keeping around a link to a scastie for a prior chisel version would be great.

I think the readme doesn't need backport. scastie cannot invoke firtool is the main issue. I think we need a RPC compiler API for scasite.

@jackkoenig jackkoenig added the Documentation Only changing documentation label Apr 12, 2023
@jackkoenig jackkoenig force-pushed the chisel5-readme branch 3 times, most recently from 5854d7b to 49f34c7 Compare April 13, 2023 23:38
@jackkoenig jackkoenig marked this pull request as ready for review April 13, 2023 23:38
@jackkoenig
Copy link
Contributor Author

I think we need to drop the scastie support for now?

Scastie is still useful for showing basic concepts, you don't always need Verilog for that. It's a shame we can't run it with firtool but I still intend to keep it around (and just generate FIRRTL)

Scastie is one of the most useful links on this page. Keeping around a link to a scastie for a prior chisel version would be great.

Agreed, I having both a 5.0.0 and a 3.6 version on here and I think we should keep it that way for a while

I think the readme doesn't need backport. scastie cannot invoke firtool is the main issue.

I'm not going to backport, but keeping the main README with a couple of versions of Chisel Scasties is useful

I think we need a RPC compiler API for scasite.

That is a large undertaking that involves funding for compute and a lot of sysadmin work that I don't think anyone really wants to do. It may be possible to get the Scastie devs to allow alternative Docker containers in which case maybe we can get one that has firtool installed. Alternatively, maybe we could do something with Compiler Explorer.

Comment on lines +13 to +33
- [What does Chisel code look like?](#what-does-chisel-code-look-like)
- [LED blink](#led-blink)
- [FIR Filter](#fir-filter)
- [Getting Started](#getting-started)
- [Bootcamp Interactive Tutorial](#bootcamp-interactive-tutorial)
- [A Textbook on Chisel](#a-textbook-on-chisel)
- [Build Your Own Chisel Projects](#build-your-own-chisel-projects)
- [Guide For New Contributors](#guide-for-new-contributors)
- [Design Verification](#design-verification)
- [Documentation](#documentation)
- [Useful Resources](#useful-resources)
- [Chisel Dev Meeting](#chisel-dev-meeting)
- [Data Types Overview](#data-types-overview)
- [Contributor Documentation](#contributor-documentation)
- [Useful Resources for Contributors](#useful-resources-for-contributors)
- [Compiling and Testing Chisel](#compiling-and-testing-chisel)
- [Running Projects Against Local Chisel](#running-projects-against-local-chisel)
- [Chisel3 Architecture Overview](#chisel3-architecture-overview)
- [Chisel Sub-Projects](#chisel-sub-projects)
- [Which version should I use?](#which-version-should-i-use)
- [Roadmap](#roadmap)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VSCode auto regenerated this which is both annoying for the churn but nice for the guaranteed accuracy.

@jackkoenig jackkoenig force-pushed the chisel5-readme branch 2 times, most recently from 3c631b6 to ca017e2 Compare April 14, 2023 00:35
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor questions

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`
Chisel consists of several Scala projects; each is its own separate compilation unit:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: why are we putting these arguably less interesting things first in the list? Should we go in at least alphabetical order?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's contributor documentation so it's helpful to know where code is. Alphabetical order makes sense although things that come first in the alphabet depend on things that come later.

@jackkoenig jackkoenig merged commit 30131f3 into main Apr 14, 2023
@jackkoenig jackkoenig deleted the chisel5-readme branch April 14, 2023 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Only changing documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants