diff options
| author | Jack Koenig | 2021-12-01 13:05:34 -0800 |
|---|---|---|
| committer | GitHub | 2021-12-01 21:05:34 +0000 |
| commit | cdb02ea4412b4cb3b42f6c78a4bae76b43be9d64 (patch) | |
| tree | cb96cad89f0abdef5b765a17aafaa63f9b07c77b | |
| parent | a476329ef7b051aa480903cacd7d62ee46980c84 (diff) | |
Update REAMDE instructions for building projects (#2270)
Include plugin in instructions since it will be required in 3.5.
Also make sure the example actually works.
| -rw-r--r-- | README.md | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -113,11 +113,18 @@ If you like a textbook to learn Chisel and also a bit of digital design in gener See [the setup instructions](SETUP.md) for how to set up your environment to build Chisel locally. -When you're ready to build your own circuits in Chisel, **we recommend starting from the [Chisel Template](https://github.com/freechipsproject/chisel-template) repository**, which provides a pre-configured project, example design, and testbench. Follow the [chisel-template readme](https://github.com/freechipsproject/chisel-template) to get started. +When you're ready to build your own circuits in Chisel, **we recommend starting from the [Chisel Template](https://github.com/freechipsproject/chisel-template) repository**, which provides a pre-configured project, example design, and testbench. +Follow the [chisel-template README](https://github.com/freechipsproject/chisel-template) to get started. -If you insist on setting up your own project, the magic SBT lines are: +If you insist on setting up your own project from scratch, your project needs to depend on both the chisel3-plugin (Scalac plugin) and the chisel3 library. +For example, in SBT this could be expressed as: ```scala +// build.sbt +scalaVersion := "2.12.13" +addCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % "3.4.4" cross CrossVersion.full) libraryDependencies += "edu.berkeley.cs" %% "chisel3" % "3.4.4" +scalacOptions += "-Xsource:2.11" +// We also recommend using chiseltest for writing unit tests libraryDependencies += "edu.berkeley.cs" %% "chiseltest" % "0.3.4" % "test" ``` ### Guide For New Contributors |