Skip to content

Commit

Permalink
Update style-guidelines.adoc
Browse files Browse the repository at this point in the history
Signed-off-by: Kersten Richter <[email protected]>
  • Loading branch information
kersten1 authored Aug 1, 2024
1 parent 28f02b1 commit 910b999
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions src/style-guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,19 @@ Whether you are creating a new extention or even a stand alone doc for RISC-V, f
Follow these basic formatting guidelines.

* Use _italic_ for new terms.
* Use `monospace` for filenames, directories, and paths.
* Use `monospace` for inline code and commands.
* Use *`monospace bold`* for hex numbers. Hex numbers start with `0x`.
* Use *`monospace bold`* for binary numbers. Binary numbers start with `0b`.
* Use *`monospace bold`* for any literals.
* Any number range, use regular font.
* Put punctuation outside of quotes, unless you are quoting someone directly.
* Use `monospace` for the following items:
** Filenames
** Directories
** Paths
** Inline code
** Commands
* Use *`monospace bold`* for the following items:
** Hex numbers. Hex numbers start with `0x`.
** Binary numbers. Binary numbers start with `0b`.
** Non-base 10 literals
** Non-base 10 number ranges

Do not use any special formatting for base 10.

.Formatting guidelines for names
* Instructions are lowercase (`ld`, `c`.`lw`)
Expand Down

0 comments on commit 910b999

Please sign in to comment.