Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.77 KB

getting_started.md

File metadata and controls

47 lines (31 loc) · 1.77 KB
Raw

Getting started

Building the compiler

You can choose between the following two options:

From .mu source

  1. Install the Muon compiler.
  2. Clone this repo. When choosing a local path, ensure that the muon and wyre repos are in the same directory. Alternatively, edit compiler/wyre.args and update the Muon standard library path before building.
  3. Go to the compiler directory (in this repo)
  4. Compile .mu sources: mu --args wyre.args
  5. Use a C compiler to compile wyre.c. E.g.:
    • GCC: gcc -o wyre wyre.c
    • MSVC: cl /Zi wyre.c
  6. You now have a Wyre compiler!

From .c source

If you prefer to not install Muon, you can take a shortcut:

  1. Clone this repo
  2. Go to the dist directory
  3. Compile wyre.c with a C compiler of your choice (see instructions above)
  4. You now have a Wyre compiler!

Running the compiler

The syntax for invoking the compiler is as follows:

wyre [flag] [source_file.w] [flag] [source_file.w] ...

Source files and flags may be mixed and may be specified in any order.

Supported flags:

  • --output [path]. The output of the compiler, a Verilog file.
  • --top [module]. Name of the topmost module in the design.
  • --indent [n]. Tab size, in spaces (learn more about significant whitespace). Set to 0 to ignore.
  • --max-errors [n]. Maximum number of compile errors to display.

To compile the leds example:

  1. Navigate to the examples directory.
  2. Run: wyre leds.w --output leds.v --top top --indent 4 --max-errors 20

Tip: to avoid having to specify all arguments every time you invoke the compiler, it is recommendeded to create a short shell script (.sh) or batch file (.bat) that contains the command.