diff options
| author | Megan Wachs | 2021-03-18 16:47:58 -0700 |
|---|---|---|
| committer | GitHub | 2021-03-18 16:47:58 -0700 |
| commit | f1ad5b58e8a749d558758288d03ce75bf6b8ff9c (patch) | |
| tree | 2150d6f41a55f81c9f4cf3b037b715cb75ea617f /docs/src/introduction.md | |
| parent | 2a56c6540e914611ac12647e157aec4c5c595758 (diff) | |
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
Diffstat (limited to 'docs/src/introduction.md')
| -rw-r--r-- | docs/src/introduction.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/src/introduction.md b/docs/src/introduction.md new file mode 100644 index 00000000..3b68aae2 --- /dev/null +++ b/docs/src/introduction.md @@ -0,0 +1,41 @@ +--- +layout: docs +title: "Introduction" +section: "chisel3" +--- + +# An Introduction to Chisel + +_Chisel_ (Constructing +Hardware In a Scala Embedded Language) is a hardware +construction language embedded in the high-level programming language +Scala. + Chisel is a library of special class +definitions, predefined objects, and usage conventions within [Scala](https://www.scala-lang.org/), +so when you write Chisel you are actually writing a Scala +program that constructs a hardware graph. +As you gain experience and want to make your code simpler or more +reusable, you will find it important to leverage the underlying power +of the Scala language. We recommend you consult one of the excellent +Scala books to become more expert in Scala programming. + +For a tutorial covering both Chisel and Scala, see the +[**online Chisel Bootcamp**](https://mybinder.org/v2/gh/freechipsproject/chisel-bootcamp/master). + +For quick reference "How-To" guides see the [Cookbooks](cookbooks/cookbooks). + +For a deeper introduction to key concepts in Chisel see the [Explanations](explanations/explanations). + +The [API Documentation](https://www.chisel-lang.org/api/) gives the detailed reference for the Chisel source code. +Note that previous versions can be found via the sidebar menu at [https://www.chisel-lang.org/chisel3]. + +The [Resources](resources/resources) provides links to other useful resources for learning and working with Chisel. + +The [Appendix](appendix/appendix) covers some more advanced topics. + +The [Developers](developers/developers) section provides information for those working on the Chisel library itself. + +>Throughout these pages, we format commentary on our design choices as in +this paragraph. You should be able to skip the commentary sections +and still fully understand how to use Chisel, but we hope you'll find +them interesting. |
