aboutsummaryrefslogtreecommitdiff
path: root/style.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2023-02-17 17:20:17 +0100
committerlonkaars <loek@pipeframe.xyz>2023-02-17 17:20:17 +0100
commit321f73a53b49913d6e1bd5f84a49302e4fbc2968 (patch)
treeb15764d013a2aeafbf9ba6dfc27aa1de5490f511 /style.md
parent4d6d5672e53c095eaf18d073004658b92402a471 (diff)
WIP ppu.vhdl
Diffstat (limited to 'style.md')
-rw-r--r--style.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/style.md b/style.md
index b81ba82..3347e60 100644
--- a/style.md
+++ b/style.md
@@ -31,15 +31,21 @@ before formatting as a failsafe.
- library hooks that need specific symbol names are exempt from the naming
conventions (e.g. `main` or `HAL_UART_MspInit`)
-### others
+## others
- document **how to use** code using doxygen-style comments in headers
- document **what code is doing** using inline comments (where applicable)
- don't write redundant comments (e.g. `int c = a + b; // add a and b`)
-## markdown
-
-### style
+### markdown
- indent using spaces, align to text start
+### vhdl
+
+- vivado puts new files in subfolders, all files (source files, constraints,
+ etc.) should be directly in the basys3/basys3.srcs/ folder
+- use snake case for naming components
+- use uppercase snake case for naming signals and I/O lines
+- use lower case keywords
+