From fffc52a2be123ecf21999cee4530705c2f9ce161 Mon Sep 17 00:00:00 2001 From: Philip Bergmann <philip.bergmann@uni-wuerzburg.de> Date: Mon, 18 Mar 2024 14:37:29 +0100 Subject: [PATCH] hint: symbols must be explained and must be consistant --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5d467a9..7703707 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ While layout changes are generally not a problem, please try to leave the title - Use raster images with lossless compression (`png`, ...) for screenshots and other images that were rastered in their original form. - Use raster images with lossy compression (`jpeg`, ...) for pictures taken with a camera. +### Symbols and Equations +- All symbols that appear in equations (or elsewhere) must be properly explained. +- Symbol usage must be consistent throughout your writeup, e.g. don't use `x(t)` to refer to the baseband and the passband signal. + ### Units and Quantities - When writing quantities, use a package like `siunitx` (if possible) - then you don't have to deal with the typography yourself. - Prefer quantity equations (equations that remain valid independent of the units, e.g. `\lambda = c / f`) and make sure the units work out. Avoid numerical-value equations (equations that depend on the quantities being expressed in specific units, e.g. `\lambda in m = 300 / f in MHz`). If numerical-value equations are required or very common, give the quantity equation beforehand. -- GitLab