From a9d3103889404ad78cdcf58f608d9b9bffe33115 Mon Sep 17 00:00:00 2001
From: donker <donker@astron.nl>
Date: Mon, 15 May 2023 13:20:47 +0200
Subject: [PATCH] RTSD-79, add readme.md

---
 tools/readme.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 tools/readme.md

diff --git a/tools/readme.md b/tools/readme.md
new file mode 100644
index 0000000000..0fcb9dab2b
--- /dev/null
+++ b/tools/readme.md
@@ -0,0 +1,30 @@
+# VHDL STYLE FIX
+
+Style fixing done:
+
+- Remove trailing spaces.
+- Add spaces around operators.
+- StandardLogic to lowercase.
+- Constants to lowercase.
+- Keywords to lowercase.
+- Types to lowercase.
+- Type Conversions to lowercase.
+- Resolutions to lowercase.
+- Attributes to lowercase.
+- Remove space between type function and bracket. 
+
+## Usage:
+
+run fix on all vhdl files:
+
+```
+cd git/hdl
+. ./init_hdl.sh
+./vhdl_style_fix_all_files.py -p 4
+```
+
+## Todo:
+
+- Align all code.
+- Check if tabs are converted to spaces.
+- Remove spaces between all type of functions and open bracked.
\ No newline at end of file
-- 
GitLab