Skip to content

dollar signs were getting backslashed in readme.md rendering. As they… #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

dollar signs were getting backslashed in readme.md rendering. As they… #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Chisel Tutorials (Development branch)
================

These are the tutorials for [Chisel](https://github.com/ucb-bar/chisel3).
These are the tutorials for [Chisel](https://github.com/chipsalliance/chisel3).

Chisel is an open-source hardware construction language developed
at UC Berkeley that supports advanced hardware design using highly
Expand All @@ -10,12 +10,12 @@ parameterized generators and layered domain-specific hardware languages.

Getting the Repo
----------------

$ git clone https://github.com/ucb-bar/chisel-tutorial.git
$ cd chisel-tutorial
$ git fetch origin
$ git checkout master

```
> git clone https://github.com/ucb-bar/chisel-tutorial.git
> cd chisel-tutorial
> git fetch origin
> git checkout master
```

Executing Chisel
----------------
Expand All @@ -24,7 +24,7 @@ Executing Chisel
First make sure that you have sbt (the scala build tool) installed. See details
in [sbt](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html).

$ sbt run
> sbt run

This will generate and test a simple block (`Hello`) that always outputs the
number 42 (aka 0x2a). You should see `[success]` on the last line of output (from sbt) and
Expand All @@ -47,7 +47,7 @@ etc) one to edit the circuit and the other to edit the tests.

To speed things up, we will keep sbt running. To get started:

$ sbt
> sbt

#### Mux2
This should already work. Try
Expand Down Expand Up @@ -88,12 +88,12 @@ memories.

To check that all of your solutions are correct:

$ ./run-problem.sh all
> ./run-problem.sh all


To run all of our reference solutions:

$ ./run-solution.sh all
> ./run-solution.sh all

Note: ./run-problem.sh, ./run-solution.sh, ./run-examples.sh are convenience scripts to invoke tests

Expand All @@ -103,14 +103,15 @@ In addition to the problems and the solutions, we have also provided some
examples of more complex circuits (`src/main/scala/examples`) and (`src/test/scala/examples`). You should take a
look at the source and test them out:

$ ./run-examples.sh all
> ./run-examples.sh all

The [wiki](https://github.com/ucb-bar/chisel-tutorial/wiki/) attached to this repo contains more information on working with Chisel.
Additional documentation may be found on the chisel3 repo
[wiki](https://github.com/ucb-bar/chisel3/wiki/)
and the
[documentation](https://chisel.eecs.berkeley.edu/documentation.html)
section of the [website](https://chisel.eecs.berkeley.edu/).
[general documentation](https://www.chisel-lang.org/chisel3/) and the
[API documentation](https://www.chisel-lang.org/latest/)
sections of the [website](https://chisel-lang.org/).

Fixes/Updates
-------------
Expand Down