Ariane RISC-V CPU

For detailed documentation refer to the online documentation (Login: zarubaf Password: zaruba).

Coding Style

• Keep the files tidy. No superfluous line breaks, align ports on a common boundary.
• All signal and module names should be lower case with underscores as whitespace replacements (e.g.: fetch_busy).
• Instantiation of modules should be postfix with _i, e.g.: prefetcher_i
• For port definitions keep a post-fix direction (_o, _i).
• For active low signals put an additional (_no, _ni).
• Denote output of ff with _q and the input with _n.
• Do not put overly large comment headers. Nevertheless, try to structure your HDL code, e.g.:

  // ------------------------------------
  // CSR - Control and Status Registers
  // ------------------------------------

Git Considerations

• Do not push to master, if you want to add a feature do it in your branch
• Separate subject from body with a blank line
• Limit the subject line to 50 characters
• Capitalize the subject line
• Do not end the subject line with a period
• Use the imperative mood in the subject line
• Wrap the body at 72 characters
• Use the body to explain what and why vs. how

For a detailed why and how please refer to one of the multiple resources regarding git commit messages.

If you use vi for your commit message, consider to put the following snippet inside your ~/.vimrc:

autocmd Filetype gitcommit setlocal spell textwidth=72s